• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1name: docs
2on:
3  # For manual pushes.
4  workflow_dispatch: 
5
6  # Pushes to main that touch the documentation directory.
7  push:
8    branches:
9      - master
10    paths:
11      - 'docs/**'
12
13permissions:
14  contents: write
15jobs:
16  deploy:
17    runs-on: ubuntu-latest
18    steps:
19      - uses: actions/checkout@v4
20      - name: Configure Git Credentials
21        run: |
22          git config user.name github-actions[bot]
23          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
24      - uses: actions/setup-python@v5
25        with:
26          python-version: 3.x
27      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
28      - uses: actions/cache@v4
29        with:
30          key: mkdocs-material-${{ env.cache_id }}
31          path: .cache
32          restore-keys: |
33            mkdocs-material-
34      - run: pip install mkdocs-material
35      - run: pip install mkdocs-redirects
36      - run: mkdocs gh-deploy --force -f docs/mkdocs.yml
37