{"repo":"rickstaa/action-black","free":true,"listed":false,"github":"https://github.com/rickstaa/action-black","clone":"git clone https://github.com/rickstaa/action-black.git","description":"Runs the psf/black formatter to check/format your python code.","language":"Shell","stars":43,"topics":["continuous-integration","python","formatter","black","codequality","gh-action","github-actions","github-actions-docker","docker"],"license":"MIT","category":"deployment-docker-iac","readme_excerpt":"Action-black GitHub Action [!IMPORTANT]\\ The official psf/black action has been released! 🚀 - Because of this, this repository's action is no longer trivial. Therefore, you are advised to use the official black action. Some features in this action are not in the official action. The differences between the two actions are documented in . If you think features are missing, please open a pull request. This action runs the black formatter to check/format your python code on a push or pull request. It is similar to reviewdog/action-black that can annotate the black changes required with Reviewdog. However, this version also allows you to format the code using GitHub actions (see #advanced-use-cases). Quickstart In it's simplest form this action can be used to check/format your code using the black formatter. Inputs black args optional : Black input arguments. Defaults to . --check --diff . fail on error optional : Exit code when black formatting errors are found \\[true, false]. Defaults to 'true'. Outputs is formatted Boolean specifying whether any files were formatted using the black formatter. Advanced use cases Annotate changes This action can be combined with reviewdog/action-suggester also to annotate any possible changes (uses git diff ). Commit changes or create a pull request This action can be combined with peter-evans/create-pull-request to also apply the annotated changes to the repository. Contributing Feel free to open an issue if you have ideas on how to make this ","default_branch":null,"files":null,"tree":[],"storefront":"/r/rickstaa","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/rickstaa/action-black/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}