This GitHub Action executes cargo doc
and posts all lints as annotations for the pushed commit 1.
This GitHub Action has been forked from clechasseur/rs-clippy-check. The original project published under the name rust-clippy-check. See LICENSE for copyright attribution details.
All inputs are optional.
| Name | Required | Description | Type | Default |
|---|---|---|---|---|
toolchain |
Rust toolchain name to use | string | ||
args |
Arguments for the command | string | ||
working-directory |
Directory where to perform the command | string | ||
tool |
Tool to use instead of cargo (cross or cargo-hack) |
string | ||
cache-key |
Cache key when using a non-cargo tool |
string | rs-clippy-check |
For extra details about the toolchain, args, tool and cache-key inputs, see rs-cargo Action.
1 : Currently, GitHub sets a limit of 10 annotations of each type per run (see this page for more information). So if there are more than 10 such lints of one type reported by clippy, only the first 10 will appear as PR annotations. The other lints will still appear in the check run summary (see this one for example).