https://github.com/sksat/action-clippy

https://github.com/sksat/action-clippy

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sksat/action-clippy
• Owner: sksat
• License: mit
• Created: 2021-12-15T20:31:27.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-25T16:07:37.000Z (8 months ago)
• Last Synced: 2024-05-01T16:21:19.082Z (8 months ago)
• Language: Shell
• Size: 94.7 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# action-clippy

This composite action runs [clippy](https://github.com/rust-lang/rust-clippy) with [reviewdog](https://github.com/reviewdog/reviewdog). 

It depends on [clippy-reviewdog-filter](https://github.com/qnighy/clippy-reviewdog-filter).

## Example workflow

```yaml

name: reviewdog / clippy

on:

  push:

    branches: [ main ]

  pull_request:

jobs:

  clippy:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - name: install clippy

        uses: dtolnay/rust-toolchain@stable

        with:

          components: clippy

      - uses: sksat/[email protected]

        if: github.event_name == 'push'

        with:

          reporter: github-check

      - uses: sksat/[email protected]

        if: github.event_name == 'pull_request'

        with:

          reporter: github-pr-review

```

## Inputs

| Name                | Required | Description | Default |

| ------------------- | :------: | ----------- | ------- |

| `github_token`      | ✓ | GitHub secret token | `${{ github.token }}` |

| `working_directory` |   | clippy working directory | |

| `tool_name`         | ✓ | Tool name to use for reviewdog reporte | `clippy` |

| `level`             | ✓ | Report level for reviewdog [info,warning,error] | `warning` |

| `reporter`          | ✓ | Reporter of reviewdog command [github-pr-check,github-pr-review,github-check] | `github-pr-check` |

| `filter_mode`       | ✓ | Filtering mode for the reviewdog command [added,diff_context,file,nofilter] | `nofilter` |

| `fail_on_error`     | ✓ | Exit code for reviewdog when errors are found | `false` |

| `reviewdog_flags`   |   | Additional reviewdog flags | |

| `clippy_flags`      |   | Additional clippy flags | |