diff options
| author | Yacin Tmimi <yacintmimi@gmail.com> | 2021-10-23 17:18:47 -0400 |
|---|---|---|
| committer | Caleb Cartwright <calebcartwright@users.noreply.github.com> | 2021-10-25 20:46:46 -0500 |
| commit | d454e8106024fcb517d8fc20d4bdd2c54229695a (patch) | |
| tree | 2c18e1dc7d59cdb99927c2fae57bc1a56ad8ca12 | |
| parent | 50369f5bc03e3011ae8383cc3cbb85ae51fe9276 (diff) | |
| download | rust-d454e8106024fcb517d8fc20d4bdd2c54229695a.tar.gz rust-d454e8106024fcb517d8fc20d4bdd2c54229695a.zip | |
Add rustdoc CI check
Resolves 5038 rust-lang/rust builds now document rustfmt (rust-lang/rust#87119). The build process is updated with doc checks to ensure that rustfmt doesn't introduce warnings. Warnings are treated as hard errors in rust-lang/rust and won't show until bors tests the changes (refs rust-lang/rust#90087).
| -rw-r--r-- | .github/workflows/rustdoc_check.yml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/.github/workflows/rustdoc_check.yml b/.github/workflows/rustdoc_check.yml new file mode 100644 index 00000000000..ca96d30f586 --- /dev/null +++ b/.github/workflows/rustdoc_check.yml @@ -0,0 +1,25 @@ +name: rustdoc check +on: + push: + branches: + - master + pull_request: + +jobs: + rustdoc_check: + runs-on: ubuntu-latest + name: rustdoc check + steps: + - name: checkout + uses: actions/checkout@v2 + + - name: install rustup + run: | + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > rustup-init.sh + sh rustup-init.sh -y --default-toolchain none + rustup target add x86_64-unknown-linux-gnu + + - name: document rustfmt + env: + RUSTDOCFLAGS: --document-private-items --enable-index-page --show-type-layout --generate-link-to-definition -Zunstable-options -Dwarnings + run: cargo doc -Zskip-rustdoc-fingerprint --no-deps -p rustfmt-nightly -p rustfmt-config_proc_macro |