53 lines
1.5 KiB
YAML
53 lines
1.5 KiB
YAML
name: build-docs
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
- "build-docs-*"
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
|
|
# Prevent concurrent runs that could conflict when pushing to gh-pages
|
|
concurrency:
|
|
group: build-docs-${{ github.ref }}
|
|
cancel-in-progress: false
|
|
|
|
permissions:
|
|
contents: write
|
|
jobs:
|
|
deploy:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
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@v6
|
|
with:
|
|
python-version: 3.x
|
|
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
|
|
- uses: actions/cache@v6
|
|
with:
|
|
key: mkdocs-material-${{ env.cache_id }}
|
|
path: .cache
|
|
restore-keys: |
|
|
mkdocs-material-
|
|
- name: Install uv
|
|
run: |
|
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
- run: uv pip install --python ${Python_ROOT_DIR} '.[dev]'
|
|
- name: Build Documentation
|
|
if: github.ref != 'refs/heads/main' && github.ref != 'refs/heads/v0.7'
|
|
run: mkdocs build
|
|
- name: Deploy on 0.7
|
|
if: github.ref == 'refs/heads/v0.7'
|
|
run: mike deploy --push 0.7
|
|
- name: Build + Deploy Documentation
|
|
if: github.ref == 'refs/heads/main'
|
|
run: mike deploy --push 1.0 latest
|