Skip to content

Commit

Permalink
docs: improve official black action notice
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa authored Dec 13, 2023
1 parent 812c19b commit d86849e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
[![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)
[![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)

> 🚀 **IMPORTANT: The official psf/black action has been released!**
> 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.
> [!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](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).

Check warning on line 9 in README.md

View workflow job for this annotation

GitHub Actions / alex

[alex] README.md#L9

Reconsider using `black`, it may be profane black retext-profanities
Raw output
      9:22-9:27  warning  Reconsider using `black`, it may be profane                                 black         retext-profanities

Check warning on line 9 in README.md

View workflow job for this annotation

GitHub Actions / alex

[alex] README.md#L9

Reconsider using `black`, it may be profane black retext-profanities
Raw output
    9:173-9:178  warning  Reconsider using `black`, it may be profane                                 black         retext-profanities
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).

Check warning on line 11 in README.md

View workflow job for this annotation

GitHub Actions / alex

[alex] README.md#L11

Reconsider using `black`, it may be profane black retext-profanities
Raw output
    11:23-11:28  warning  Reconsider using `black`, it may be profane                                 black         retext-profanities

Check warning on line 11 in README.md

View workflow job for this annotation

GitHub Actions / alex

[alex] README.md#L11

Reconsider using `black`, it may be profane black retext-profanities
Raw output
  11:237-11:242  warning  Reconsider using `black`, it may be profane                                 black         retext-profanities

Expand Down

0 comments on commit d86849e

Please sign in to comment.