1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# Builds and deploys the calc documentation site to GitHub Pages.
#
# Method: artifact-based deploy (actions/upload-pages-artifact +
# actions/deploy-pages). The built site is handed straight to GitHub's Pages
# servers as a workflow artifact - there is no `gh-pages` branch, no orphan
# history, nothing in `git log --all` that did not come from a real commit.
#
# Repo prerequisite (one-off): Settings -> Pages -> Source must be set to
# "GitHub Actions". If it is set to "Deploy from a branch", deploy-pages
# fails with "Get Pages site failed". This is set once on the repo and
# persists.
#
# Action SHAs are copied from the sibling repos' docs workflows (the canonical
# living examples) and carry the matching `# vX.Y.Z` comment per house style.
name: docs
on:
push:
branches:
- main
paths:
- "docs/**"
- "examples/**"
- "mkdocs.yml"
- "requirements.txt"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: "3.x"
- uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
with:
key: zensical-${{ env.cache_id }}
path: ~/.cache
restore-keys: |
zensical-
- run: pip install -r requirements.txt
- run: zensical build --clean
# When the distribution pipeline (cargo-dist) lands, drop install.sh /
# install.ps1 installer proxies into site/ here, as the sibling repos do,
# so the site can host the curl-able one-liners.
- uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0