Skip to content

CID-2779 (#358)

CID-2779 (#358) #487

Workflow file for this run

name: Deploy to gh-pages
on:
push:
branches: [main]
workflow_dispatch:
env:
MODULE_LIST_PATH: docs/assets/module-list.json
PYTHON_VERSION: 3.x
GH_TOKEN: ${{ github.token }}
permissions:
contents: write
pull-requests: write
id-token: write
pages: write
jobs:
documentation:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
sparse-checkout: |
docs
overrides
- name: Set up Python runtime
uses: actions/setup-python@v5
with:
python-version: ${{ env.PYTHON_VERSION }}
cache: pip
cache-dependency-path: requirements.txt
- name: Set up build cache
uses: actions/cache/restore@v4
with:
key: mkdocs-${{ hashfiles('.cache/**') }}
path: .cache
restore-keys: |
mkdocs-
- name: Install Python dependencies
run: pip install -r requirements.txt
- name: Build documentation
run: |
mkdocs build --clean --quiet
- name: Adjust permissions
run: |
chmod -c -R +rX public/ | while read line; do
echo "::info title=Invalid file permissions automatically fixed::$line"
done
- name: Upload to GitHub Pages
uses: actions/upload-pages-artifact@v3
with:
path: public
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
- name: Save build cache
uses: actions/cache/save@v4
with:
key: mkdocs-${{ hashfiles('.cache/**') }}
path: .cache