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

Change Open Container source annotation to the openHAB distro repository #444

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mpgirro
Copy link

@mpgirro mpgirro commented Sep 30, 2024

This PR changes the OpenContainer (OCI) image source annotation value to the openhab-distro repository URL.

Tools like Dependabot and Renovate use this Docker image label when opening PRs for dependency updates. The URL allows these tools to show detailed information about image changes (release notes, changelog entries), making it easier for developers to evaluate the impact of updates.

openHAB uses a separate (this) repository to build Docker images, but neither GitHub releases nor Changelog entries are maintained in this repo. This information is present in the openhab-distro repository instead.

When we change the org.opencontainers.image.source label value to the distro package, we enable these tools to fetch the proper information that is being published with new releases, improving the integration of our images with existing and widely used dependency management tools.

@mpgirro mpgirro requested a review from a team as a code owner September 30, 2024 15:53
Copy link
Member

@wborn wborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://specs.opencontainers.org/image-spec/annotations/:

org.opencontainers.image.source URL to get source code for building the image (string)

The changes in this PR make it more difficult for developers to find the image source code. AFAIK the main use of the annotation is to simplify finding and inspecting the image source code and also use it for building your own images.

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

Successfully merging this pull request may close these issues.

2 participants