benny123tw/Run ruff with reviewdog

🐶 Run ruff with reviewdog on pull requests to improve code review experience.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stalelast commit Jan 19, 2025
License
None

Pinned Snippet

workflow.ymlSHA-pinned
uses: benny123tw/action-ruff@226d241bdf7205e6e048f1407d21bd69a64b7298 # v1.1.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
github_tokenGITHUB_TOKEN.yes${{ github.token }}
levelReport level for reviewdog [info,warning,error]noerror
reporterReporter of reviewdog command [github-check,github-pr-review]. Default is github-pr-review. github-pr-review can use Markdown and add a link to rule page in reviewdog reports. nogithub-pr-review
filter_modeFiltering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is added. noadded
fail_levelIf set to `none`, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. Possible values: [none,any,info,warning,error] Default is `none`. none
fail_on_errorDeprecated, use `fail_level` instead. Exit code for reviewdog when errors are found [true,false] Default is `false`. nofalse
reviewdog_flagsAdditional reviewdog flagsno""
ruff_flagsflags and args of ruff command. Default: '.'no""
workdirThe directory from which to look for and run eslint. Default '.'no.
tool_nameTool name to use for reviewdog reporternoeslint
changed_filesWhether to only run Ruff on changed files. Defaults to `true`.notrue

no outputs