From 6085b60d808fd270336d41229dc240db94247710 Mon Sep 17 00:00:00 2001 From: Jonathen Adkins Date: Mon, 1 Jun 2026 02:52:00 -0400 Subject: [PATCH] docs: add GitHub Pages auto-deploy workflow - Deploy VitePress docs to GitHub Pages on push to main - Uses actions/deploy-pages for zero-config hosting - Build step installs deps, runs vitepress build, uploads artifact - Deploy step publishes to github-pages environment Closes #21 --- .github/workflows/docs.yml | 51 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..76b4edf --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,51 @@ +name: Deploy Docs to GitHub Pages + +on: + push: + branches: [main] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: 20 + cache: npm + cache-dependency-path: docs/package-lock.json + + - name: Install dependencies + run: cd docs && npm ci + + - name: Build docs + run: cd docs && npm run docs:build + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: docs/.vitepress/dist + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4