From fdd5ef8a12a853b54444f6d7e9a12cd38c226967 Mon Sep 17 00:00:00 2001 From: Lacey-Anne Sanderson Date: Sat, 30 Mar 2024 21:25:24 -0600 Subject: [PATCH] Create gh-pages.yml --- .github/workflows/gh-pages.yml | 52 ++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 .github/workflows/gh-pages.yml diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 0000000..bc1cdd3 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,52 @@ +name: Deploy Documentation using MkDocs +on: + push: + branches: ["2.x"] + 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 + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - uses: actions/setup-python@v5 + with: + python-version: '3.18' + - name: Install Depenendancies + run: pip install mkdocs mkdocs-material + - name: Build Documentation + run: | + cd mkdocs + mkdocs build + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: mkdocs/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