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
name: mdBook Deployment
on:
push:
branches:
- main
paths:
- 'doc/**'
- '.github/workflows/mdbook.yml'
workflow_dispatch:
# Every action is pinned to a commit SHA rather than a tag, the same rule
# `ci.yml` states and for the same reason: a tag is mutable, and this workflow
# holds a token that can write to GitHub Pages. The trailing comment is the tag
# the SHA stood for when it was pinned; update both together.
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
# Pinned, not 'latest': an upstream mdBook release should not be able to
# break a deployment with no change on this side. Installed as prebuilt
# binaries rather than `cargo install` from source, which took minutes.
# Keep these versions in step with the `docs` job in `ci.yml`.
- name: Install mdBook
uses: taiki-e/install-action@67729d5c413db75907f0ad1e39bb04b9c868ff60 # v2
with:
tool: mdbook@0.5.4,mdbook-mermaid@0.17.0
- name: Style and link check
run: python3 doc/lint.py
- name: Build mdBook
run: mdbook build doc/
- name: Setup Pages
uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4
- name: Upload artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
with:
path: './doc/book'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4