From d4a1fda95070293b379db4dd10abb8e0f0ffe650 Mon Sep 17 00:00:00 2001 From: Hazel Atkinson Date: Mon, 6 May 2024 15:47:50 +0100 Subject: [PATCH] [ci] deploy docs preview using gh actions --- .github/workflows/docs-publish.yml | 55 ++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 .github/workflows/docs-publish.yml diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml new file mode 100644 index 0000000..3a7db48 --- /dev/null +++ b/.github/workflows/docs-publish.yml @@ -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