This action runs the black formatter to check/format your code on a push or pull request.
optional: Black input arguments. Defaults to . --check --diff
.
optional: Exit code when black formatting errors are found [true, false]. Defaults to 'true'.
Boolean specifying whether any files were formatted using the black formatter.
In it's simplest form this action can be used to check/format your code using the black formatter.
name: reviewdo
on: [push, pull_request]
jobs:
linter_name:
name: runner / black formatter
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: reviewdog/action-black@v1
with:
black_args: ". --check"
This action can be combined with reviewdog/action-suggester also to annotate any possible changes (uses git diff
).
name: reviewdog
on: [push, pull_request]
jobs:
name: runner / black
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Check files using black formatter
uses: rickstaa/action-black@v1
id: action-black
with:
black_args: "."
- name: Annotate diff changes using reviewdog
if: steps.action-black.outputs.is_formatted == 'true'
uses: reviewdog/action-suggester@v1
with:
tool_name: blackfmt
This action can be combined with peter-evans/create-pull-request to also apply the annotated changes to the repository.
name: reviewdog
on: [push, pull_request]
jobs:
name: runner / black
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Check files using black formatter
uses: rickstaa/action-black@v1
id: action-black
with:
black_args: "."
- name: Create Pull Request
if: steps.action-black.outputs.is_formatted == 'true'
uses: peter-evans/create-pull-request@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
title: "Format Python code with psf/black push"
commit-message: ":art: Format Python code with psf/black"
body: |
There appear to be some python formatting errors in ${{ github.sha }}. This pull request
uses the [psf/black](https://github.com/psf/black) formatter to fix these issues.
branch: actions/black