mirror of
https://github.com/docker/metadata-action.git
synced 2026-03-19 16:20:20 +08:00
docs: Add advice for pre-release tag support with v prefix
This caveat was not easily apparent and has tripped up users. This addition should help raise awareness in advance of triggering the mistake. Signed-off-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
This commit is contained in:
parent
ed95091677
commit
4100df91ca
1 changed files with 10 additions and 0 deletions
10
README.md
10
README.md
|
|
@ -532,6 +532,10 @@ with the following expressions:
|
||||||
> if specified) as tag because they are updated frequently, and contain many
|
> if specified) as tag because they are updated frequently, and contain many
|
||||||
> breaking changes that are (by the author's design) not yet fit for public
|
> breaking changes that are (by the author's design) not yet fit for public
|
||||||
> consumption.
|
> consumption.
|
||||||
|
>
|
||||||
|
> If you expect to process pre-release versions that prepend or retain a `v` prefix
|
||||||
|
> for the image tag, do not add the prefix in `pattern` (as shown in the table above),
|
||||||
|
> instead add `,prefix=v` which will [avoid inconsistent tag generation][caveat::pre-release-tag].
|
||||||
|
|
||||||
Extended attributes and default values:
|
Extended attributes and default values:
|
||||||
|
|
||||||
|
|
@ -585,6 +589,10 @@ with the following expressions:
|
||||||
> specified) as tag because they are updated frequently, and contain many
|
> specified) as tag because they are updated frequently, and contain many
|
||||||
> breaking changes that are (by the author's design) not yet fit for public
|
> breaking changes that are (by the author's design) not yet fit for public
|
||||||
> consumption.
|
> consumption.
|
||||||
|
>
|
||||||
|
> If you expect to process pre-release versions that prepend or retain a `v` prefix
|
||||||
|
> for the image tag, do not add the prefix in `pattern` (as shown in the table above),
|
||||||
|
> instead add `,prefix=v` which will [avoid inconsistent tag generation][caveat::pre-release-tag].
|
||||||
|
|
||||||
Extended attributes and default values:
|
Extended attributes and default values:
|
||||||
|
|
||||||
|
|
@ -1051,3 +1059,5 @@ More information about annotations in the [BuildKit documentation](https://githu
|
||||||
|
|
||||||
Want to contribute? Awesome! You can find information about contributing to
|
Want to contribute? Awesome! You can find information about contributing to
|
||||||
this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)
|
this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)
|
||||||
|
|
||||||
|
[caveat::pre-release-tag]: https://github.com/docker/metadata-action/issues/422#issuecomment-3797351389
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue