Skip to content
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

Jump to bottom

Add release metadata to the released Docker images #2392

Closed
jpeach opened this issue Mar 27, 2020 · 1 comment · Fixed by #2400
Closed

Add release metadata to the released Docker images #2392

jpeach opened this issue Mar 27, 2020 · 1 comment · Fixed by #2400
Assignees
@jpeach
Milestone
1.4.0

Comments

@jpeach
Copy link
Contributor

jpeach commented Mar 27, 2020

There's no way to cross-check the Docker images we release against the source code that it was built from. We should add Docker labels that tracks release metadata.

The OCI spec defines a set of standard labels and these seem to be in use by many projects:

https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys

We should add:

Label Content
org.opencontainers.image.created timestamp
org.opencontainers.image.url Link to github release notes?
org.opencontainers.image.documentation Link to docs
org.opencontainers.image.source Link to GitHub tarball download?
org.opencontainers.image.version Release tag name
org.opencontainers.image.revision Full git SHA
org.opencontainers.image.vendor ???
org.opencontainers.image.licenses SPDX apache2
org.opencontainers.image.title Contour
org.opencontainers.image.description descriptive text
@jpeach jpeach self-assigned this Mar 27, 2020
@jpeach jpeach added this to the 1.4.0 milestone Mar 27, 2020
@jpeach
Copy link
Contributor Author

jpeach commented Mar 27, 2020

Targeting for 1.40, so we can get this on the next release.

jpeach added a commit to jpeach/contour that referenced this issue Mar 30, 2020
@jpeach
build: apply standard Docker image labels
d9d6902 
Apply Docker image labels standardized in the OCI container image spec.
This improves our ability to trace the provenance of a Contour image
back to the corresponding source code.

This fixes projectcontour#2392.

Signed-off-by: James Peach <[email protected]>
@jpeach jpeach mentioned this issue Mar 30, 2020
Merged
stevesloka pushed a commit that referenced this issue Apr 3, 2020
@jpeach
build: apply standard Docker image labels (#2400)
5e86b01 
Apply Docker image labels standardized in the OCI container image spec.
This improves our ability to trace the provenance of a Contour image
back to the corresponding source code.

Fixes #2392

Signed-off-by: James Peach <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jpeach jpeach

Labels
None yet
Projects
None yet
Milestone
1.4.0
Development

Successfully merging a pull request may close this issue.

build: apply standard Docker image labels jpeach/contour
1 participant
@jpeach