Skip to content

Commit

Permalink
Deny warnings when generating documentation in CI
Browse files Browse the repository at this point in the history
Our cargo doc invocation in CI is expected to fail when detecting
issues. However, given the way it is invoked currently, it is more
likely to emit warnings instead. Obviously, those may go undetected for
a long time.
To fix this issue, this change makes sure to set the RUSTDOCFLAGS in
such a way that cargo doc denies any warnings, converting them to errors
instead.
  • Loading branch information
d-e-s-o committed Nov 15, 2022
1 parent 1ab9c71 commit 3e92097
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ jobs:
cargo-doc:
name: Generate documentation
runs-on: ubuntu-latest
env:
RUSTDOCFLAGS: '-D warnings'
steps:
- uses: actions/checkout@v3
- uses: actions-rs/toolchain@v1
Expand Down

0 comments on commit 3e92097

Please sign in to comment.