mirror of
https://github.com/thegeeklab/docker-autotag.git
synced 2024-11-14 04:30:40 +00:00
79 lines
3.5 KiB
Markdown
79 lines
3.5 KiB
Markdown
# docker-autotag
|
|
|
|
Create docker tags from a given version string
|
|
|
|
[](https://ci.thegeeklab.de/repos/thegeeklab/docker-autotag)
|
|
[](https://hub.docker.com/r/thegeeklab/docker-autotag)
|
|
[](https://quay.io/repository/thegeeklab/docker-autotag)
|
|
[](https://pypi.org/project/docker-autotag/)
|
|
[](https://pypi.org/project/docker-autotag/)
|
|
[](https://pypi.org/project/docker-autotag/)
|
|
[](https://github.com/thegeeklab/docker-autotag/graphs/contributors)
|
|
[](https://github.com/thegeeklab/docker-autotag)
|
|
[](https://github.com/thegeeklab/docker-autotag/blob/main/LICENSE)
|
|
|
|
Simple tool to create a list of docker tags from a given version string.
|
|
|
|
## Environment variables
|
|
|
|
```Shell
|
|
# if not set a comma-separated list will be printed to stdout
|
|
DOCKER_AUTOTAG_OUTPUT_FILE=
|
|
# adds a given suffix to every determined tag
|
|
DOCKER_AUTOTAG_SUFFIX=
|
|
# returns only tags with the applied suffix
|
|
DOCKER_AUTOTAG_SUFFIX_STRICT=False
|
|
# version string to use; returns 'latest' if nothing is specified
|
|
DOCKER_AUTOTAG_VERSION=
|
|
# comma-seprated list of static tags to add to the result set
|
|
DOCKER_AUTOTAG_EXTRA_TAGS=
|
|
# 'latest' tag would only be used if determined tag list is empty; adds always 'latest' to the result
|
|
DOCKER_AUTOTAG_FORCE_LATEST=False
|
|
# if the given version string contains a prerelease, no other tags will be returned
|
|
DOCKER_AUTOTAG_IGNORE_PRERELEASE=False
|
|
```
|
|
|
|
## Examples
|
|
|
|
```Shell
|
|
DOCKER_AUTOTAG_VERSION=1.0.1 docker-autotag
|
|
# 1.0.1,1.0,1
|
|
|
|
DOCKER_AUTOTAG_VERSION=0.1.0 docker-autotag
|
|
# 0.1.0, 0.1
|
|
|
|
## 'v' prefixes e.g. from git tags will be removed
|
|
DOCKER_AUTOTAG_VERSION=v1.0.1 docker-autotag
|
|
# 1.0.1,1.0,1
|
|
|
|
## unsufficient semver version strings will be tried to convert automatically
|
|
## if conversion doesn't work return 'latest'
|
|
DOCKER_AUTOTAG_VERSION=1.0 docker-autotag
|
|
# 1.0.0,1.0,1
|
|
|
|
DOCKER_AUTOTAG_VERSION=1.0.0-beta docker-autotag
|
|
# 1.0.0-beta
|
|
|
|
## ignore prerelease to always get a full list of tags
|
|
DOCKER_AUTOTAG_IGNORE_PRERELEASE=True DOCKER_AUTOTAG_VERSION=1.0.0-beta docker-autotag
|
|
# 1.0.0-beta,1.0.0,1.0,1
|
|
|
|
DOCKER_AUTOTAG_SUFFIX=amd64 DOCKER_AUTOTAG_VERSION=1.0.0 docker-autotag
|
|
# 1.0.0,1.0,1,1.0.0-amd64,1.0-amd64,1-amd64
|
|
|
|
DOCKER_AUTOTAG_SUFFIX=amd64 DOCKER_AUTOTAG_SUFFIX_STRICT=True DOCKER_AUTOTAG_VERSION=1.0.0 docker-autotag
|
|
# 1.0.0-amd64,1.0-amd64,1-amd64
|
|
|
|
DOCKER_AUTOTAG_EXTRA_TAGS=extra1,extra2 DOCKER_AUTOTAG_VERSION=1.0.0 docker-autotag
|
|
# 1.0.0,1.0,1,extra1,extra2
|
|
```
|
|
|
|
## Contributors
|
|
|
|
Special thanks to all [contributors](https://github.com/thegeeklab/docker-autotag/graphs/contributors). If you would like to contribute,
|
|
please see the [instructions](https://github.com/thegeeklab/docker-autotag/blob/main/CONTRIBUTING.md).
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/docker-autotag/blob/main/LICENSE) file for details.
|