Skip to content

Commit 21e8116

Browse files
committed
CI: Surface rustdoc warnings
Soft fails like warnings from rustc. The `rustdoc` warnings tend to be dead links in the markup.
1 parent 32b98d7 commit 21e8116

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

.github/workflows/rust-warnings.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ permissions:
2121
contents: read
2222

2323
jobs:
24-
make:
24+
rust-warnings:
2525
env:
2626
GITPULLOPTIONS: --no-tags origin ${{ github.ref }}
2727

@@ -46,6 +46,15 @@ jobs:
4646
run: |
4747
set -eu
4848
cargo check --quiet --all-features --message-format=json \
49-
| jq -r 'select(.message.level == "warning" or .message.level == "error") | .message.rendered' \
49+
| jq -r 'select(.message.level | IN("warning", "error")) | .message.rendered' \
50+
| tee messages.txt
51+
(exit "${PIPESTATUS[0]}") && ! grep --quiet '[^[:space:]]' messages.txt
52+
53+
- name: "📜 `rustdoc` warnings"
54+
shell: bash
55+
run: |
56+
set -eu
57+
cargo doc --document-private-items --all --no-deps --message-format=json \
58+
| jq -r 'select(.message.level | IN("warning", "error")) | .message.rendered' \
5059
| tee messages.txt
5160
(exit "${PIPESTATUS[0]}") && ! grep --quiet '[^[:space:]]' messages.txt

0 commit comments

Comments
 (0)