This action runs the black formatter with reviewdog on pull requests to improve code review experience.

In it's simplest form this action can be used to annotate the changes the black formatter would make if it was run on the code.

name: reviewdog
on: [pull_request]
jobs:
  linter_name:
    name: runner / black formatter
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: reviewdog/action-black@v2
        with:
          github_token: ${{ secrets.github_token }}
          # Change reviewdog reporter if you need [github-pr-check, github-check].
          reporter: github-pr-check
          # Change reporter level if you need.
          # GitHub Status Check won't become failure with a warning.
          level: warning

Required. The GITHUB_TOKEN. Must be in form of github_token: ${{ secrets.github_token }}. Defaults to ${{ github.token }}.

Optional. The directory to run remark-lint in. Defaults to ..

Optional. Additional black input arguments. Defaults to "".

Optional. Tool name to use for reviewdog reporter. Defaults to remark-lint.

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

Optional. Reporter of reviewdog command [github-pr-check, github-pr-review, github-check]. Default is github-pr-check.

Optional. Filtering mode for the reviewdog command [added, diff_context, file, nofilter]. Defaults to added.

Optional. Exit code for when reviewdog when errors are found [true, false]. Defaults to false.

Optional. Additional reviewdog flags. Defaults to "".

This action is meant to annotate any possible changes that would need to be made to make your code adhere to the black formatting guidelines. It does not apply these changes to your codebase. If you also want to apply the changes to your repository, you can use the reviewdog/action-suggester. You can find examples of how this is done can be found in rickstaa/action-black