Skip to content

IlyaGulya/action-actionlint

 
 

Repository files navigation

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

Docker-based (default)

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

Dockerless

If you prefer to run without Docker, a dockerless version is also available:

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

The dockerless version directly installs actionlint and reviewdog on the runner without using Docker. This can be useful in environments where Docker is not available.

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_level

Optional. If 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.

fail_on_error

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

reviewdog_flags

Optional. Additional reviewdog flags

About

run actionlint with reviewdog

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 50.1%
  • Dockerfile 49.9%