Add OCI image labels #1924
Open
Add OCI image labels #1924
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Qup42
commented
Feb 6, 2024
| "org.opencontainers.image.source"="https://github.com/containrrr/watchtower" \ | ||
| "org.opencontainers.image.licenses"="Apache-2.0" \ | ||
| # unsure about capitalization | ||
| "org.opencontainers.image.title"="watchtower" \ |
There was a problem hiding this comment.
Are there any feelings about the capitalization of watchtower? As a non-native speaker I am a bit unsure.
| "org.opencontainers.image.title"="watchtower" \ | ||
| "org.opencontainers.image.description"="A process for automating Docker container base image updates." \ | ||
| # The version might be forgotten. The version could be extraced into a `ARG` before the initial `FROM` or removed. | ||
| "org.opencontainers.image.base.name"="alpine:3.19.0" |
There was a problem hiding this comment.
Any feelings? If not I would tend towards removing the concrete version. It adds little in additional information but makes the Dockerfile somewhat more complex.
There was a problem hiding this comment.
You could be able to do something like
ARG BASE_IMAGE=alpine:3.19.0
FROM --platform=$BUILDPLATFORM $BASE_IMAGE as alpine
[..]
FROM scratch
ARG BASE_IMAGE
LABEL "org.opencontainers.image.base.name"="$BASE_IMAGE"can't comment on if it would be useful in practice (can't recall ever looking for the labels myself)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds Labels to the Docker Image. The added Labels conform to the Annotations defined in the OCI Image Format Specification.
The following labels are added for releases (dev and tagged):
org.opencontainers.image.urlorg.opencontainers.image.documentationorg.opencontainers.image.sourceorg.opencontainers.image.licensesorg.opencontainers.image.titleorg.opencontainers.image.descriptionorg.opencontainers.image.base.nameTagged releases are additionally labeled with
org.opencontainers.image.createdorg.opencontainers.image.versionorg.opencontainers.image.revisionImage Labels are considered a best practice for Container Images. They make it easier to handle Images and reconstruct which version one is running. Image Labels also enable tools for automatic dependency updates (like Renovate and Dependabot) to automatically retrieve and display Release Notes for an update.
I tested the changes locally with
goreleaser release --skip-publish --skip-validate --rm-dist. The images had the expected labels. There are no existing test suites that apply to this change.Documentation updates are not required for this change.