Skip to content

Commit 66c667a

Browse files
committed
feat(ci): check rustdocs on build
1 parent 489b235 commit 66c667a

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

.github/actions/rust-build/action.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,4 @@ runs:
2929
if: ${{ inputs.run-tests == 'true' }}
3030
shell: bash
3131
run: cargo test --all-features --verbose --package ${{ inputs.package }}
32+

.github/workflows/check-docs.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Check rustdocs
2+
# this is its own workflow since we to to use unstable
3+
# to have the docs.rs display of feature flags
4+
5+
on:
6+
push:
7+
paths:
8+
- 'lambda*'
9+
- 'Cargo.toml'
10+
11+
pull_request:
12+
paths:
13+
- 'lambda*'
14+
- 'Cargo.toml'
15+
16+
jobs:
17+
build-runtime:
18+
runs-on: ubuntu-latest
19+
20+
env:
21+
RUST_BACKTRACE: 1
22+
steps:
23+
- uses: dtolnay/rust-toolchain@master
24+
with:
25+
toolchain: unstable
26+
27+
- name: Check documentation
28+
shell: bash
29+
env:
30+
RUSTFLAGS: --cfg docsrs
31+
RUSTDOCFLAGS: --cfg docsrs -Dwarnings
32+
run: cargo doc --no-deps --document-private-items --all-features

0 commit comments

Comments
 (0)