Allow user to select the version of black to mitigate the effects of braking update of black

Black action

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

Quick Start

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@v3
      # Install specific version black (this step is not required. default is "black[jupyter]")
      - run: pip install black==23.1.0
      - uses: reviewdog/action-black@v3
        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

Inputs

`github_token`

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

`workdir`

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

`black_args`

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

Warning Because this action uses the black output to create the annotations, it does not work with the black --quiet flag.

`verbose`

Optional. Set to true to print the black output to the github action console. Defaults to false.

`tool_name`

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

`level`

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

`reporter`

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

`filter_mode`

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

`fail_on_error`

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

`reviewdog_flags`

Optional. Additional reviewdog flags. Defaults to "".

Outputs

Environment variables

`BLACK_CHECK_FILE_PATHS`

Contains all the files that would be changed by black.

Format your code

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

Error type	Exit code
Linting errors found	1
No linting errors found	0
Input argument error	2
Internal error (e.g. python syntax error)	123

Error type	Exit code
Formatting not needed	0
Formatting successful	0
Input argument error	2
Internal error (e.g. python syntax error)	123

	# remove last two lines of black output, since they are irrelevant
	unset "black_check_file_paths[-1]"
	unset "black_check_file_paths[-1]"

reviewdog / action-black Goto Github PK

action-black's Introduction

Black action

Quick Start

Inputs

github_token

workdir

black_args

verbose

tool_name

level

reporter

filter_mode

fail_on_error

reviewdog_flags

Outputs

Environment variables

BLACK_CHECK_FILE_PATHS

Format your code

action-black's People

Contributors

Stargazers

Watchers

Forkers

action-black's Issues

Reviewdog exit codes

Black exit codes

Exit codes without formatting

Exit codes with formatting

Stderr/stdout behavoir

suggestion

Detected dependencies

Recommend Projects

Recommend Topics

Recommend Org