Skip to content

Commit

Permalink
[ci] deploy docs preview using gh actions
Browse files Browse the repository at this point in the history
  • Loading branch information
yellowsink committed May 6, 2024
1 parent 9a35a03 commit d4a1fda
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/docs-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Deploy documentation

on:
push:
branches: ["docs-rewrite"]

workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
# setup
- uses: actions/checkout@v4

- uses: actions/setup-node@v3
with:
node-version: 20.x

- name: Install deps
run: |
npm install -g pnpm
pnpm i --frozen-lockfile
# build
- name: Build docs
run: |
cd packages/shelter-docs
pnpm build
cd ../..
# deploy
- uses: actions/configure-pages@v5
- uses: actions/upload-pages-artifact@v3
with:
# Upload dist folder
path: 'packages/shelter-docs/docs/.vitepress/dist'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit d4a1fda

Please sign in to comment.