Docker image usage description (#2412)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
This commit is contained in:
parent
d7b091e762
commit
1d7163957a
46
docs/usage_and_configuration/black_docker_image.md
Normal file
46
docs/usage_and_configuration/black_docker_image.md
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
# Black Docker image
|
||||||
|
|
||||||
|
Official _Black_ Docker images are available on Docker Hub:
|
||||||
|
https://hub.docker.com/r/pyfound/black
|
||||||
|
|
||||||
|
_Black_ images with the following tags are available:
|
||||||
|
|
||||||
|
- release numbers, e.g. `21.5b2`, `21.6b0`, `21.7b0` etc.\
|
||||||
|
ℹ Recommended for users who want to use a particular version of _Black_.
|
||||||
|
- `latest_release` - tag created when a new version of _Black_ is released.\
|
||||||
|
ℹ Recommended for users who want to use released versions of _Black_. It maps to [the latest release](https://github.com/psf/black/releases/latest)
|
||||||
|
of _Black_.
|
||||||
|
- `latest` - tag used for the newest image of _Black_.\
|
||||||
|
ℹ Recommended for users who always want to use the latest version of _Black_, even before
|
||||||
|
it is released.
|
||||||
|
|
||||||
|
There is one more tag used for _Black_ Docker images - `latest_non_release`. It is
|
||||||
|
created for all unreleased
|
||||||
|
[commits on the `main` branch](https://github.com/psf/black/commits/main). This tag is
|
||||||
|
not meant to be used by external users.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
A permanent container doesn't have to be created to use _Black_ as a Docker image. It's
|
||||||
|
enough to run _Black_ commands for the chosen image denoted as `:tag`. In the below
|
||||||
|
examples, the `latest_release` tag is used. If `:tag` is omitted, the `latest` tag will
|
||||||
|
be used.
|
||||||
|
|
||||||
|
More about _Black_ usage can be found in
|
||||||
|
[Usage and Configuration: The basics](./the_basics.md).
|
||||||
|
|
||||||
|
### Check Black version
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker run --rm pyfound/black:latest_release black --version
|
||||||
|
```
|
||||||
|
|
||||||
|
### Check code
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker run --rm --volume $(pwd):/src --workdir /src pyfound/black:latest_release black --check .
|
||||||
|
```
|
||||||
|
|
||||||
|
_Remark_: besides [regular _Black_ exit codes](./the_basics.md) returned by `--check`
|
||||||
|
option, [Docker exit codes](https://docs.docker.com/engine/reference/run/#exit-status)
|
||||||
|
should also be considered.
|
@ -7,6 +7,7 @@ Usage and Configuration
|
|||||||
the_basics
|
the_basics
|
||||||
file_collection_and_discovery
|
file_collection_and_discovery
|
||||||
black_as_a_server
|
black_as_a_server
|
||||||
|
black_docker_image
|
||||||
|
|
||||||
Sometimes, running *Black* with its defaults and passing filepaths to it just won't cut
|
Sometimes, running *Black* with its defaults and passing filepaths to it just won't cut
|
||||||
it. Passing each file using paths will become burdensome, and maybe you would like
|
it. Passing each file using paths will become burdensome, and maybe you would like
|
||||||
@ -22,3 +23,4 @@ This section covers features of *Black* and configuring *Black* in detail:
|
|||||||
- :doc:`The basics <./the_basics>`
|
- :doc:`The basics <./the_basics>`
|
||||||
- :doc:`File collection and discovery <file_collection_and_discovery>`
|
- :doc:`File collection and discovery <file_collection_and_discovery>`
|
||||||
- :doc:`Black as a server (blackd) <./black_as_a_server>`
|
- :doc:`Black as a server (blackd) <./black_as_a_server>`
|
||||||
|
- :doc:`Black Docker image <./black_docker_image>`
|
||||||
|
Loading…
Reference in New Issue
Block a user