Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 1.77 KB

README.md

File metadata and controls

64 lines (41 loc) · 1.77 KB
Raw

GitHub Action: Run actionlint with reviewdog

This action runs actionlint with reviewdog on pull requests to improve code review experience.

example of broken workflow

shellcheck and pyflakes integrations are enabled by default.

example of shellcheck example of pyflakes

Example usages

name: reviewdog
on: [pull_request]
jobs:
  actionlint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: reviewdog/action-actionlint@v1

Inputs

github_token

Required. Default is ${{ github.token }}.

actionlint_flags

Optional. actionlint flags. (actionlint -oneline <actionlint_flags>)

tool_name

Optional. Tool name to use for reviewdog reporter. Useful when running multiple actions with different config.

level

Optional. Report level for reviewdog [info,warning,error]. It's same as -level flag of reviewdog.

reporter

Optional. Reporter of reviewdog command [github-pr-check,github-pr-review]. It's same as -reporter flag of reviewdog.

filter_mode

Optional. Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is file.

fail_on_error

Optional. Exit code for reviewdog when errors are found [true,false] Default is false.

reviewdog_flags

Optional. Additional reviewdog flags