GitHub Action: Run ktlint with reviewdog
This action runs ktlint with reviewdog on pull requests to enforce best practices.
Examples
github-pr-check
With By default, with reporter: github-pr-check
an annotation is added to
the line:
github-pr-review
With With reporter: github-pr-review
a comment is added to
the Pull Request Conversation:
Inputs
github_token
Required. Must be in form of github_token: ${{ secrets.github_token }}
.
level
Optional. Report level for reviewdog [info
,warning
,error
].
It's same as -level
flag of reviewdog.
The default is error
.
reporter
Optional. Reporter of reviewdog command [github-pr-check
,github-pr-review
].
The default is github-pr-check
.
Example usage
name: reviewdog
on: [pull_request]
jobs:
ktlint:
name: Check Code Quality
runs-on: ubuntu-latest
steps:
- name: Clone repo
uses: actions/checkout@master
with:
fetch-depth: 1
- name: ktlint
uses: ScaCap/action-ktlint@master
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review # Change reporter