From bd798309e33754b61f016175f9520f23fa3e83c8 Mon Sep 17 00:00:00 2001 From: Connor Feeley Date: Sat, 18 Nov 2023 09:00:00 -0500 Subject: [PATCH] github: add action to build options documentation --- .github/workflows/options-doc.yml | 53 +++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 .github/workflows/options-doc.yml diff --git a/.github/workflows/options-doc.yml b/.github/workflows/options-doc.yml new file mode 100644 index 0000000..31ede83 --- /dev/null +++ b/.github/workflows/options-doc.yml @@ -0,0 +1,53 @@ +name: Deploy options documentation site to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["master"] + + # Allows you to run this workflow manually from the Actions tab + 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: + # Build job + build: + runs-on: ubuntu-latest + env: + MDBOOK_VERSION: 0.4.21 + steps: + - uses: actions/checkout@v3 + - uses: DeterminateSystems/nix-installer-action@main + - uses: DeterminateSystems/magic-nix-cache-action@main + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - name: Build options documentation. + run: nix build --verbose --show-trace --print-build-logs .#options-doc + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: ./result + + # Deployment job + 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@v2