Skip to content

Commit de291d4

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

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

.github/workflows/check-docs.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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-runtime/**'
9+
- 'lambda-runtime-api-client/**'
10+
- 'lambda-http/**'
11+
- 'lambda-events/**'
12+
- 'lambda-extension/**'
13+
- 'Cargo.toml'
14+
15+
pull_request:
16+
paths:
17+
- 'lambda-runtime/**'
18+
- 'lambda-runtime-api-client/**'
19+
- 'lambda-http/**'
20+
- 'lambda-events/**'
21+
- 'lambda-extension/**'
22+
- 'Cargo.toml'
23+
24+
jobs:
25+
build-runtime:
26+
runs-on: ubuntu-latest
27+
28+
env:
29+
RUST_BACKTRACE: 1
30+
steps:
31+
- uses: actions/checkout@v3
32+
- uses: dtolnay/rust-toolchain@nightly
33+
34+
- name: Check documentation
35+
shell: bash
36+
env:
37+
RUSTFLAGS: --cfg docsrs
38+
RUSTDOCFLAGS: --cfg docsrs -Dwarnings
39+
run: cargo doc --no-deps --document-private-items --all-features

0 commit comments

Comments
 (0)