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

Support human readable tags on docker-compose ecosystem #11658

Open
1 task done
gegoune opened this issue Feb 21, 2025 · 1 comment
Open
1 task done

Support human readable tags on docker-compose ecosystem #11658

gegoune opened this issue Feb 21, 2025 · 1 comment
Labels
L: docker Docker containers L: go:modules Golang modules T: feature-request Requests for new features

Comments

@gegoune
Copy link

gegoune commented Feb 21, 2025

Is there an existing issue for this?

  • I have searched the existing issues

Feature description

Following up from #390 (comment).

It is a common practice to complement digest versioned docker images in compose files with human readable tags by inline comment, such as:

image: postgres@sha256:a35ec42526e3c522eb13b4d82eddaee875d0ac6ca9eb5cc5607e412854478c71 # 16.7

Reasons behind such practice are:

  • using digests instead of tags due to tag's mutability
  • digests aren't descriptive enough for humans, they don't convey actual tag along

Currently Dependabot offers updates for above declaration with PR:

Title: build(deps): bump postgres from a35ec42 to 0321e22

This does not convey any meaning. It's impossible to tell which tag is being proposed. As far as I know registries don't support searching by digest, but even if they did, it would require extra step from users to find out what's going on.

And proposing following changes:

-image: postgres@sha256:a35ec42526e3c522eb13b4d82eddaee875d0ac6ca9eb5cc5607e412854478c71 # 16.7
+image: postgres@sha256:0321e2252ebfeecb8bc1a899755084d29bce872953e1a5a3e25ec0860b739098 # 16.7

Please note that comment is not updated. That leads to outdated information resulting in false assumptions by future readers.


This feature request therefore is about two things:

  1. using human readable tags in PR's subject even when digest are used to pin images
Title: `build(deps): bump postgres from 16.7 to 16.8`
  1. updating human readable tag in inline comment alongside corresponding digest
-image: postgres@sha256:a35ec42526e3c522eb13b4d82eddaee875d0ac6ca9eb5cc5607e412854478c71 # 16.7
+image: postgres@sha256:0321e2252ebfeecb8bc1a899755084d29bce872953e1a5a3e25ec0860b739098 # 16.8

(or whatever tag that digest points to).

@gegoune gegoune added the T: feature-request Requests for new features label Feb 21, 2025
@github-actions github-actions bot added L: docker Docker containers L: go:modules Golang modules labels Feb 21, 2025
@abdulapopoola
Copy link
Member

Thanks @gegoune , I suspect this will also apply to docker as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L: docker Docker containers L: go:modules Golang modules T: feature-request Requests for new features
Projects
Status: No status
Development

No branches or pull requests

2 participants