diff --git a/README.md b/README.md index 188025e..6a7bcd8 100644 --- a/README.md +++ b/README.md @@ -524,6 +524,10 @@ with the following expressions: > 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 > 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: @@ -577,6 +581,10 @@ with the following expressions: > 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 > 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: @@ -1043,3 +1051,5 @@ More information about annotations in the [BuildKit documentation](https://githu Want to contribute? Awesome! You can find information about contributing to this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md) + +[caveat::pre-release-tag]: https://github.com/docker/metadata-action/issues/422#issuecomment-3797351389