actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Support version specifiers in GH action (#3265)

Browse Source 
Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>
This commit is contained in:
Jakub Kuczys 2022-09-23 05:23:35 +02:00 committed by GitHub
parent 4c99900236
commit bfc013ab93
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES.md
View File

@ -47,6 +47,9 @@
<!-- For example, Docker, GitHub Actions, pre-commit, editors --> <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
- Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black
version (#3265)
### Documentation ### Documentation
<!-- Major changes to documentation and policies. Small docs changes <!-- Major changes to documentation and policies. Small docs changes

7
action/main.py
View File

@ -14,9 +14,10 @@
run([sys.executable, "-m", "venv", str(ENV_PATH)], check=True) run([sys.executable, "-m", "venv", str(ENV_PATH)], check=True)
req = "black[colorama]" version_specifier = VERSION
if VERSION: if VERSION and VERSION[0] in "0123456789":
req += f"=={VERSION}" version_specifier = f"=={VERSION}"
req = f"black[colorama]{version_specifier}"
pip_proc = run( pip_proc = run(
[str(ENV_BIN / "python"), "-m", "pip", "install", req], [str(ENV_BIN / "python"), "-m", "pip", "install", req],
stdout=PIPE, stdout=PIPE,

21
docs/integrations/github_actions.md
View File

@ -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_ that. Note that the action's version you select is independent of the version of _Black_
the action will use. the action will use.
The version of _Black_ the action will use can be configured via `version`. The action The version of _Black_ the action will use can be configured via `version`. This can be
defaults to the latest release available on PyPI. Only versions available from PyPI are any
supported, so no commit SHAs or branch names. [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 You can also configure the arguments passed to _Black_ via `options` (defaults to
`'--check --diff'`) and `src` (default is `'.'`) `'--check --diff'`) and `src` (default is `'.'`)
@ -48,3 +51,15 @@ Here's an example configuration:
src: "./src" src: "./src"
version: "21.5b1" 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"
```