Skip to content

Commit d205ffb

Browse files
committed
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).
1 parent 5f4811e commit d205ffb

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

.github/workflows/rustdoc_check.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: rustdoc check
2+
on:
3+
push:
4+
branches:
5+
- master
6+
pull_request:
7+
8+
jobs:
9+
rustdoc_check:
10+
runs-on: ubuntu-latest
11+
name: rustdoc check
12+
steps:
13+
- name: checkout
14+
uses: actions/checkout@v2
15+
16+
- name: install rustup
17+
run: |
18+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > rustup-init.sh
19+
sh rustup-init.sh -y --default-toolchain none
20+
rustup target add x86_64-unknown-linux-gnu
21+
22+
- name: document rustfmt
23+
env:
24+
RUSTDOCFLAGS: --document-private-items --enable-index-page --show-type-layout --generate-link-to-definition -Zunstable-options -Dwarnings
25+
run: cargo doc -Zskip-rustdoc-fingerprint --no-deps -p rustfmt-nightly -p rustfmt-config_proc_macro

0 commit comments

Comments
 (0)