Skip to content

[Merged by Bors] - Fail CI on cargo doc warnings #2012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/bors.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ status = [
"build-android",
"markdownlint",
"run-examples",
"check-doc",
]

use_squash_merge = true
8 changes: 5 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ jobs:
sleep 10
done

deadlinks:
check-doc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
Expand All @@ -138,6 +138,8 @@ jobs:
if: runner.os == 'linux'
- name: Installs cargo-deadlinks
run: cargo install cargo-deadlinks
- name: Checks dead doc links
run: cargo doc --all-features --no-deps && cargo deadlinks --dir target/doc/bevy
- name: Build and check doc
run: RUSTDOCFLAGS='-D warnings' cargo doc --all-features --no-deps
- name: Checks dead links
run: cargo deadlinks --dir target/doc/bevy
continue-on-error: true