action-ruff

Run ruff on pull requests with reviewdog to get inline annotations for Python linting violations.

Usage

name: reviewdog
on: [pull_request]
jobs:
  ruff:
    name: runner / ruff
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
      - uses: benner/action-ruff@v1
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-review
          level: warning

Inputs

Name	Description	Default
github_token	GitHub token	${{ github.token }}
workdir	Working directory relative to the root	.
level	Report level: info, warning, error	error
reporter	reviewdog reporter: github-pr-check, github-check, github-pr-review	github-pr-check
filter_mode	Filter mode: added, diff_context, file, nofilter	added
fail_level	Fail if issues at or above level: none, any, info, warning, error	none
reviewdog_flags	Additional reviewdog flags	''
ruff_args	Additional arguments passed to ruff check	''

Development

Release

Bump version by merging a PR with a bump:major, bump:minor, or bump:patch label. haya14busa/action-bumpr handles the tag, haya14busa/action-update-semver keeps v1 / v1.2 aliases in sync.

Dependencies

reviewdog/action-depup runs daily to update the reviewdog and ruff versions in the Dockerfile and open a PR.