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

docs: Set org.opencontainers.image.source label in Dockerfile #3564

Conversation

dmarcoux
Copy link
Contributor

@dmarcoux dmarcoux commented Dec 19, 2024

As documented in the OCI Image Format, org.opencontainers.image.source identifies an image's source repository. This is purely for documentation purposes. It does however help tools such as Renovate to find the changelogs when a new Navidrome version is released. The changelogs would then be included in the PR Renovate creates.

Just as an example, here's a screenshot of a Renovate PR which cannot find Navidrome's changelogs, so they are simply omitted.

Example...

renovate-pr-without-release-notes

As documented in the OCI Image Format,
org.opencontainers.image.source[1] identifies an image's source
repository. This is purely for documentation purposes. It does however
help tools such as Renovate[2] to find the changelogs when a new
Navidrome version is released. The changelogs would then be included in
the PR Renovate creates.

[1]: https://github.com/opencontainers/image-spec/blob/5325ec48851022d6ded604199a3566254e72842a/annotations.md#L24
[2]: https://docs.renovatebot.com/modules/datasource/docker/#description

Signed-off-by: Dany Marcoux <git@dmarcoux.com>
@dmarcoux dmarcoux force-pushed the dockerfile-label-org.opencontainers.image.url branch from bf3e187 to 65bd2f9 Compare December 19, 2024 21:30
@deluan
Copy link
Member

deluan commented Dec 19, 2024

Thanks!

@deluan deluan merged commit 21dd04c into navidrome:master Dec 19, 2024
31 checks passed
@dmarcoux dmarcoux deleted the dockerfile-label-org.opencontainers.image.url branch December 20, 2024 06:42
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