From f5ba8a061b61cbd6593fec1c5e1c5512ebc3351a Mon Sep 17 00:00:00 2001 From: Tom Hlava Date: Thu, 22 Aug 2024 10:45:31 +0200 Subject: [PATCH] GHa workflow for mkdocs and GH pages --- .github/workflows/mkdocs_ghpages.yaml | 58 +++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 .github/workflows/mkdocs_ghpages.yaml diff --git a/.github/workflows/mkdocs_ghpages.yaml b/.github/workflows/mkdocs_ghpages.yaml new file mode 100644 index 0000000..f65a105 --- /dev/null +++ b/.github/workflows/mkdocs_ghpages.yaml @@ -0,0 +1,58 @@ +name: Run mkdocs and deploy to GitHub Pages + +on: +# push: +# branches: ["master"] + 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: + mkdocs: + runs-on: ubuntu-latest + env: + PYTHON_VERSION: "3.10" + steps: + - name: Set up Python ${{ env.PYTHON_VERSION }} + uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Run mkdocs + id: run-mkdocs + run: | + python -m venv .venv + . .venv/bin/activate + pip install -e . + mkdocs build + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: "site/" + + deploy-pages: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: mkdocs + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4