atuinsh / atuin

✨ Magical shell history
https://atuin.sh
MIT License
20.31k stars 549 forks source link

Add well-known image labels to Docker image to link back to repository #1701

Open JJGadgets opened 7 months ago

JJGadgets commented 7 months ago

GHCR supports using the org.opencontainers.image.source well-known image label to link users from the ghcr.io page back to the project repository page. It would probably also be good to have the other well-known labels just for metadata sakes.

https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#labelling-container-images https://docs.github.com/en/packages/learn-github-packages/connecting-a-repository-to-a-package#connecting-a-repository-to-a-container-image-using-the-command-line https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys

Additionally, setting the org.opencontainers.image.source label allows Renovate to automatically grab the changelog for new releases and insert to the version update PR.

https://docs.renovatebot.com/modules/datasource/docker/

ellie commented 7 months ago

Thank for the suggestion! I'd happily review a PR for this if anyone fancies it 🙏