X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/14072be245b909d2340e13c571e76bf36080cc5a..bfc013ab93d0993a6e24235291dddd4c4ecd64ee:/docs/integrations/github_actions.md diff --git a/docs/integrations/github_actions.md b/docs/integrations/github_actions.md index e866a3c..d77b969 100644 --- a/docs/integrations/github_actions.md +++ b/docs/integrations/github_actions.md @@ -8,8 +8,8 @@ environment. Great for enforcing that your code matches the _Black_ code style. This action is known to support all GitHub-hosted runner OSes. In addition, only published versions of _Black_ are supported (i.e. whatever is available on PyPI). -Finally, this action installs _Black_ with both the `colorama` and `python2` extras so -the `--color` flag and formatting Python 2 code are supported. +Finally, this action installs _Black_ with the `colorama` extra so the `--color` flag +should work fine. ## Usage @@ -32,9 +32,12 @@ We recommend the use of the `@stable` tag, but per version tags also exist if yo that. Note that the action's version you select is independent of the version of _Black_ the action will use. -The version of _Black_ the action will use can be configured via `version`. The action -defaults to the latest release available on PyPI. Only versions available from PyPI are -supported, so no commit SHAs or branch names. +The version of _Black_ the action will use can be configured via `version`. This can be +any +[valid version specifier](https://packaging.python.org/en/latest/glossary/#term-Version-Specifier) +or just the version number if you want an exact version. The action defaults to the +latest release available on PyPI. Only versions available from PyPI are supported, so no +commit SHAs or branch names. You can also configure the arguments passed to _Black_ via `options` (defaults to `'--check --diff'`) and `src` (default is `'.'`) @@ -48,3 +51,15 @@ Here's an example configuration: src: "./src" version: "21.5b1" ``` + +If you want to match versions covered by Black's +[stability policy](labels/stability-policy), you can use the compatible release operator +(`~=`): + +```yaml +- uses: psf/black@stable + with: + options: "--check --verbose" + src: "./src" + version: "~= 22.0" +```