feat(docs): add website with mdBook and automated deployment #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build & deploy website | |
| on: | |
| push: | |
| branches: [ main ] | |
| paths: | |
| - 'docs/**' | |
| - '**.nix' | |
| pull_request: | |
| paths: | |
| - 'docs/**' | |
| - '**.nix' | |
| jobs: | |
| build: | |
| name: Build site | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Nix | |
| uses: cachix/install-nix-action@v30 | |
| - name: Run build | |
| run: | | |
| nix build \ | |
| --print-build-logs \ | |
| --show-trace \ | |
| '.#site' | |
| - name: Get artifact directory | |
| id: find-path | |
| run: | | |
| # exit if no `result` from `nix build` | |
| [ ! -L result ] && exit 1 | |
| echo "path=$(readlink -f result)" >> "$GITHUB_OUTPUT" | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ${{ steps.find-path.outputs.path }} | |
| deploy: | |
| name: Deploy site | |
| if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deploy.outputs.page_url }} | |
| permissions: | |
| id-token: write | |
| pages: write | |
| steps: | |
| - name: Deploy to GitHub pages | |
| id: deploy | |
| uses: actions/deploy-pages@v4 |