]> git.lizzy.rs Git - rust.git/commitdiff
Add rustdoc CI check
authorYacin Tmimi <yacintmimi@gmail.com>
Sat, 23 Oct 2021 21:18:47 +0000 (17:18 -0400)
committerCaleb Cartwright <calebcartwright@users.noreply.github.com>
Tue, 26 Oct 2021 01:46:46 +0000 (20:46 -0500)
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).

.github/workflows/rustdoc_check.yml [new file with mode: 0644]

diff --git a/.github/workflows/rustdoc_check.yml b/.github/workflows/rustdoc_check.yml
new file mode 100644 (file)
index 0000000..ca96d30
--- /dev/null
@@ -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