From 53afdada7db4382586ea6de9786623eac9237dff Mon Sep 17 00:00:00 2001 From: "James P. Howard, II" Date: Sun, 9 Jun 2024 21:19:45 -0400 Subject: [PATCH] Add MkDocs deployer --- .github/workflows/mkdocs.yaml | 50 +++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/workflows/mkdocs.yaml diff --git a/.github/workflows/mkdocs.yaml b/.github/workflows/mkdocs.yaml new file mode 100644 index 0000000..1a54e5a --- /dev/null +++ b/.github/workflows/mkdocs.yaml @@ -0,0 +1,50 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Deploy MkDocs site to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: main + +# 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 + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Build with MkDocs + uses: jnanadarshan/mkdocs-build-action@v1 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'site/' + + # 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@v4