actions-rs/ clippy-check
About the developer
193 Stars 
15 Forks 
MIT License 
43 Commits 
35 Opened issues 
Description
đź“Ž GitHub Action for PR annotations with clippy warnings
Services available
Contributors list
Rust clippy-check
Action
Clippy lints in your Pull Requests
clippyand posts all lints as annotations for the pushed commit, as in the live example here.
Example workflow
toolchainActions to install the most recent
nightlyclippy version.
on: push
name: Clippy check
jobs:
clippy_check:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: actions-rs/[email protected]
with:
toolchain: nightly
components: clippy
override: true
- uses: actions-rs/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
args: --all-features
With stable clippy
on: push
name: Clippy check
jobs:
clippy_check:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- run: rustup component add clippy
- uses: actions-rs/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
args: --all-features
Inputs
| Name | Required | Description | Type | Default | | ------------| :------: | ---------------------------------------------------------------------------------------------------------------------------------------| ------ | --------| |
token| âś“ | GitHub secret token, usually a
${{ secrets.GITHUB_TOKEN }} | string | |
| toolchain| | Rust toolchain to use; override or system default toolchain will be used if omitted | string | | |
args| | Arguments for the
cargo clippycommand | string | | |
use-cross| | Use
crossinstead of
cargo| bool | false | |
name| | Name of the created GitHub check. If running this action multiple times, each run must have a unique name. | string | clippy |
For extra details about the
toolchain,
argsand
use-crossinputs, see
cargoAction documentation.
NOTE: if your workflow contains multiple instances of the
clippy-checkaction you will need to give each invocation a unique name, using the
nameproperty described above. Check runs must have a unique name, and this prevents a later check run overriding a previous one within the same workflow.
Limitations
Due to token permissions, this Action WILL NOT be able to post
clippyannotations for Pull Requests from the forked repositories.
This is a pretty big problem, which can be solved only by Github themselves, see #2 for details.\ As a fallback this Action will output all clippy messages into the stdout and fail the result correspondingly.