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.

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

Proposal: Annotation for URL to artwork/logo for an OCI Image #1231

Open
AlexGustafsson opened this issue Dec 22, 2024 · 0 comments
Open

Proposal: Annotation for URL to artwork/logo for an OCI Image #1231

AlexGustafsson opened this issue Dec 22, 2024 · 0 comments

Comments

@AlexGustafsson
Copy link

Proposal

Add an annotation like org.opencontainers.image.artwork which contains a URL to an image (as in a logo or the like) for an OCI image, much like a favicon.

User stories

  • As an OCI image author I'd like the project's logo to be seen alongside information about the OCI image on sites such as Docker Hub, GHCR, Quay and tools such Renovate, Socket(.dev).

  • As a developer of a service collecting information about container images, I'd like to show the users artwork / a logo for the image to help the user easily recognize the service contained in an OCI images.

Background

OCI images are maintained in different ways, in different places. Be it pushing an image built locally or pushing an image in a CI/CD pipeline with code hosted here on GitHub. Some code hosting sites may also act as an OCI registry. Some developers might push to several registries. Some sights may mirror the images or make them discoverable through various UIs.

Today, the standardized annotations provide a lot of good information about to ensure that the OCI image developers can annotate their images once and ensure that information is spread across all of these sites. Similarly, developers of such sites can reuse the information contained in the annotations to display information about the OCI images.

However, there is no standardized way to communicate what artwork / logo should be associated with the OCI image. This requires OCI image developers to upload an image to each site separately. For developers of services not used directly by the OCI image developer, the only choice is to try to identify artwork based on heuristics or simply falling back to a placeholder.

@AlexGustafsson AlexGustafsson changed the title Proposal: Standardized annotation for URL to artwork/logofor an OCI Image Proposal: Annotation for URL to artwork/logo for an OCI Image Dec 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant