Skip to content

docs: Add advice for pre-release image tag (v prefix support) #590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
polarathene wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −0
Open

docs: Add advice for pre-release image tag (v prefix support) #590

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,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:

Expand Down Expand Up @@ -585,6 +589,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:

Expand Down Expand Up @@ -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
this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)

[caveat::pre-release-tag]: https://github.com/docker/metadata-action/issues/422#issuecomment-3797351389