Awesome
GitHub Action: Run yamllint with reviewdog
This action runs yamllint with reviewdog on pull requests to improve code review experience.
Inputs
github_token
Optional. ${{ github.token }}
is used by default.
level
Optional. Report level for reviewdog [info,warning,error].
It's same as -level
flag of reviewdog.
reporter
Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].
Default is github-pr-check.
It's same as -reporter
flag of reviewdog.
github-pr-review can use Markdown and add a link to rule page in reviewdog reports.
filter_mode
Optional. Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is added.
fail_on_error
Optional. Exit code for reviewdog when errors are found [true,false] Default is false
.
reviewdog_flags
Optional. Additional reviewdog flags.
yamllint_flags
Optional. Flags and args of yamllint command. Default: '.'
Example usage
You can create yamllint config and this action uses that config too.
.github/workflows/reviewdog.yml
name: reviewdog
on: [pull_request]
jobs:
yamllint:
name: runner / yamllint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: yamllint
uses: reviewdog/action-yamllint@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review # Change reporter.
yamllint_flags: 'src/'