Skip to content

Commit 18461db

Browse files
committed
ci: add job to check cargo doc
1 parent 4d4adae commit 18461db

2 files changed

Lines changed: 21 additions & 1 deletion

File tree

.github/workflows/cont_integration.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,3 +146,18 @@ jobs:
146146
- name: Clippy
147147
run: cargo clippy --all-features --all-targets -- -D warnings
148148

149+
docs_check:
150+
name: Check cargo doc
151+
runs-on: ubuntu-latest
152+
steps:
153+
- name: Checkout
154+
uses: actions/checkout@v6
155+
with:
156+
persist-credentials: false
157+
# This action automatically reads and applies rust-toolchain.toml
158+
- name: Install Rust toolchain
159+
uses: actions-rust-lang/setup-rust-toolchain@v1
160+
with:
161+
cache: true
162+
- name: Check docs
163+
run: RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps

justfile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ alias c := check
33
alias f := fmt
44
alias t := test
55
alias p := pre-push
6+
alias d := doc
67

78
_default:
89
@just --list
@@ -28,5 +29,9 @@ fmt:
2829
test:
2930
cargo test --all-features
3031

32+
# Check docs on the workspace
33+
doc:
34+
RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps
35+
3136
# Run pre-push suite: format, check, and test
32-
pre-push: fmt check test
37+
pre-push: fmt check test doc

0 commit comments

Comments
 (0)