Skip to content

Commit 2f2614b

Browse files
committed
chore: add workflow to publish crate docs to gh pages
1 parent 3309fa6 commit 2f2614b

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

.github/workflows/build-docs.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Build docs and publish to github pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- chore/docs
8+
9+
jobs:
10+
publish:
11+
permissions:
12+
contents: read
13+
id-token: write
14+
pages: write
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Setup Rust cache
20+
uses: Swatinem/rust-cache@v2
21+
22+
- name: Install Rust toolchain
23+
run: |
24+
rustup set profile minimal
25+
rustup show
26+
27+
- name: Install Protoc
28+
uses: arduino/setup-protoc@v1
29+
with:
30+
version: 3.20.1
31+
repo-token: ${{ secrets.GITHUB_TOKEN }}
32+
33+
- name: Generate Docs
34+
run: |
35+
cargo doc --workspace --no-deps
36+
37+
- name: Setup Pages
38+
uses: actions/configure-pages@v5
39+
40+
- name: Upload artifact
41+
uses: actions/upload-pages-artifact@v3
42+
with:
43+
path: 'target/doc/'
44+
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)