Fail CI on cargo doc warnings (#2012)
* makes CI fails on cargo doc warnings * adds this check in bors doc warnings are listed here: https://doc.rust-lang.org/rustdoc/lints.html Currently the warnings emitted are: * broken_intra_doc_links * private_intra_doc_links * invalid_codeblock_attributes
This commit is contained in:
parent
c32c37d737
commit
723fe91183
1
.github/bors.toml
vendored
1
.github/bors.toml
vendored
@ -8,6 +8,7 @@ status = [
|
|||||||
"build-android",
|
"build-android",
|
||||||
"markdownlint",
|
"markdownlint",
|
||||||
"run-examples",
|
"run-examples",
|
||||||
|
"check-doc",
|
||||||
]
|
]
|
||||||
|
|
||||||
use_squash_merge = true
|
use_squash_merge = true
|
||||||
|
|||||||
8
.github/workflows/ci.yml
vendored
8
.github/workflows/ci.yml
vendored
@ -129,7 +129,7 @@ jobs:
|
|||||||
sleep 10
|
sleep 10
|
||||||
done
|
done
|
||||||
|
|
||||||
deadlinks:
|
check-doc:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
@ -138,6 +138,8 @@ jobs:
|
|||||||
if: runner.os == 'linux'
|
if: runner.os == 'linux'
|
||||||
- name: Installs cargo-deadlinks
|
- name: Installs cargo-deadlinks
|
||||||
run: cargo install cargo-deadlinks
|
run: cargo install cargo-deadlinks
|
||||||
- name: Checks dead doc links
|
- name: Build and check doc
|
||||||
run: cargo doc --all-features --no-deps && cargo deadlinks --dir target/doc/bevy
|
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
|
continue-on-error: true
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user