Skip to content

ci: trigger docs deploy on mkdocs.yml and workflow changes (#441) #24

ci: trigger docs deploy on mkdocs.yml and workflow changes (#441)

ci: trigger docs deploy on mkdocs.yml and workflow changes (#441) #24

Workflow file for this run

name: Deploy Docs
permissions:
contents: write
pages: write
id-token: write
on:
push:
branches:
- main
paths:
- "docs/site/**"
- "mkdocs.yml"
- ".github/workflows/mkdocs.yaml"
workflow_dispatch:
jobs:
build_mkdocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: ~/.cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: pip install mkdocs-git-revision-date-localized-plugin
- run: mkdocs gh-deploy --force
deploy_mkdocs:
needs: build_mkdocs
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: gh-pages
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "."
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4