From dbcbec49c71b6f95b663c266b26e77f4447def1f Mon Sep 17 00:00:00 2001 From: Jan Graichen Date: Wed, 8 Jan 2025 20:36:49 +0100 Subject: [PATCH] chore: Build and deploy docs to GitHub pages --- .github/workflows/docs.yml | 41 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..ea830a5 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,41 @@ +--- +name: docs + +on: + push: + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: "3.13" + cache: pipenv + - run: pip install pipenv + - run: pipenv install --dev + - run: pipenv run mkdocs build --verbose --site-dir tmp/mkdocs/site + - uses: actions/upload-pages-artifact@v3 + with: + path: tmp/mkdocs/site + + deploy: + needs: build + + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + # Only deploy from main branch + if: ${{ github.ref == 'refs/heads/main' }} + + runs-on: ubuntu-24.04 + steps: + - uses: actions/deploy-pages@v4 + id: deployment