README.md

GitHub Action - rust-clippy-reborn

Clippy lints in your commits and Pull Requests

Table of Contents

• GitHub Action - rust-clippy-reborn
  • Motivation
  • Example workflow
    • With stable clippy
  • Inputs
  • Contribute and support

Motivation

This is a next gen version of actions-rs/clippy-check and it's in an unstable state right now, as it uses unstable/undocumented GitHub Actions features and potentially can break at any time.

Compared to actions-rs/clippy-check it has few advantages:

1. GITHUB_TOKEN secret is not required anymore, using this Action is much safer in terms of security
2. It works correctly for Pull Requests created from forked repositories

Example workflow

This example is using the toolchain action to install the most recent nightly clippy version.

on: [push, pull_request]
name: Clippy
jobs:
  clippy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: crusty-pie/toolchain@v1
        with:
          toolchain: nightly
          components: clippy
          override: true
      - uses: crusty-pie/clippy@v1
        with:
          args: --all-features --all-targets

With stable clippy

on: [push, pull_request]
name: Clippy
jobs:
  clippy_check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: crusty-pie/toolchain@v1
        with:
          toolchain: stable
          components: clippy
      - uses: crusty-pie/clippy@v1
        with:
          args: --all-features --all-targets

Inputs

Name	Required	Description	Type	Default
args	false	Arguments for the cargo clippy command	string	''

Contribute and support

Any contributions are welcomed!

If you want to report a bug or have a feature request, check the Contributing guide.