Skip to content

Commit d86849e

Browse files
authored
docs: improve official black action notice
1 parent 812c19b commit d86849e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rickstaa/action-black?logo=github\&sort=semver)](https://github.com/rickstaa/action-black/releases)
66
[![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github\&link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)
77

8-
> 🚀 **IMPORTANT: The official psf/black action has been released!**
9-
> Since `psf/black` has been released, the action in this repository is not trivial anymore. Therefore, you are advised to use the [official black](https://black.readthedocs.io/en/stable/integrations/github_actions.html) action. Some features in this action are not in the official action. The differences between the two actions are documented in <https://github.com/rickstaa/action-black/issues/10>. Please open a [pull request](https://github.com/rickstaa/action-black/pulls) if you think features are missing.
8+
> [!IMPORTANT]\
9+
> **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](https://black.readthedocs.io/en/stable/integrations/github_actions.html) action. Some features in this action are not in the official action. The differences between the two actions are documented in <https://github.com/rickstaa/action-black/issues/10>. If you think features are missing, please open a [pull request](https://github.com/rickstaa/action-black/pulls).
1010
1111
This action runs the [black formatter](https://github.com/psf/black) to check/format your python code on a push or pull request. It is similar to [reviewdog/action-black](https://github.com/reviewdog/action-black) that can annotate the black changes required with [Reviewdog](https://github.com/reviewdog/reviewdog). However, this version also allows you to format the code using GitHub actions (see #advanced-use-cases).
1212

0 commit comments

Comments
 (0)