release v21.0.0 #689
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: docs | |
on: | |
push: | |
branches: | |
- master | |
pull_request: | |
branches: | |
- master | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
# Fetch all history for applying timestamps to every page | |
fetch-depth: 0 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.12' | |
- name: Install Hatch | |
uses: pypa/hatch@install | |
- name: Check documentation | |
run: hatch run docs:build-check | |
- name: Build documentation | |
run: hatch run docs:build | |
- uses: actions/upload-artifact@v4 | |
with: | |
name: documentation | |
path: site | |
publish: | |
runs-on: ubuntu-latest | |
if: github.event_name == 'push' && github.ref == 'refs/heads/master' | |
needs: | |
- build | |
steps: | |
- uses: actions/download-artifact@v4 | |
with: | |
name: documentation | |
path: site | |
- uses: peaceiris/actions-gh-pages@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./site | |
commit_message: ${{ github.event.head_commit.message }} | |
# Write .nojekyll at the root, see: | |
# https://help.github.com/en/github/working-with-github-pages/about-github-pages#static-site-generators | |
enable_jekyll: false | |
# Only deploy if there were changes | |
allow_empty_commit: false |