Skip to content
paperclip

GitHub Action

rs-clippy-check

v3.0.3 Latest version

rs-clippy-check

paperclip

rs-clippy-check

Run clippy and annotate the diff with errors and warnings

Installation

Copy and paste the following snippet into your .yml file.

              
- name: rs-clippy-check

              
  uses: clechasseur/[email protected]
Learn more about this action in clechasseur/rs-clippy-check

Choose a version

rs-clippy-check Action

MIT licensed Continuous integration

Clippy lints in your Pull Requests

This GitHub Action executes clippy and posts all lints as annotations for the pushed commit 1.

Screenshot of a clippy warning displayed in the commit interface of GitHub

This GitHub Action has been forked from actions-rs/clippy-check. The original project published under the name rust-clippy-check. See LICENSE for copyright attribution details.

Example workflow

Note: this workflow uses dtolnay/rust-toolchain to install the most recent nightly clippy.

name: Clippy check

on: push

jobs:
  clippy_check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@nightly
        with:
          components: clippy
      - uses: clechasseur/rs-clippy-check@v3
        with:
          args: --all-features

Inputs

All inputs are optional.

Name Description Type Default
toolchain Rust toolchain to use; override or system default toolchain will be used if omitted string
args Arguments for the cargo clippy command string
use-cross Use cross instead of cargo bool false
working-directory Directory where to perform the cargo clippy command string

For extra details about the toolchain, args and use-cross inputs, see rs-cargo Action.

Notes

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).