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
name: Docs
on:
push:
branches:
paths:
- "book/**"
- "README.md"
- "CHANGELOG.md"
- "SECURITY.md"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- name: Install mdbook
run: |
MDBOOK_VERSION=0.4.40
curl -L https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz
chmod +x mdbook
echo "$(pwd)" >> $GITHUB_PATH
- name: Sync top-level docs into the book
run: |
cp README.md book/src/project/readme.md || true
cp CHANGELOG.md book/src/project/changelog.md
cp SECURITY.md book/src/project/security.md
cp docs/exporters.md book/src/architecture/exporters.md 2>/dev/null || true
- name: Build book
run: |
cd book && mdbook build
- uses: actions/configure-pages@v5
- uses: actions/upload-pages-artifact@v3
with:
path: book/book
- id: deployment
uses: actions/deploy-pages@v4