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

Release Note and Changelog #85

Closed
corasaniti opened this issue Apr 26, 2022 · 3 comments
Closed

Release Note and Changelog #85

corasaniti opened this issue Apr 26, 2022 · 3 comments

Comments

@corasaniti
Copy link

Hi

it would be nice for every release or push to dockehub, to write a release note or changelog to know the improvements and changes.
Thanks

@ansemjo
Copy link
Owner

ansemjo commented Apr 27, 2022

Hi, thanks for the suggestion!

  1. In general, I am in the process of moving away from DockerHub. The ansemjo/speedtest image is the last one that I still push on my DockerHub account. My GitHub action workflows mostly push to GitHub's own container registry ghcr.io now: ghcr.io/ansemjo/speedtest
  2. I remember that when we created the GitHub workflows, there was an issue that you could not update an image's description using token authentication. I dug around and apparently the issue still exists today: feature request: provide way to update a repo's description and full_description docker/hub-tool#172

Therefore, as a compromise, would maintaining a CHANGELOG.md in-repo and linking to it from the Readme and image description on DockerHub be adequate? For most of the things that dependabot updates through its pull-requests, I don't even bother to bump the minor version because those updates shouldn't change any functionality. Was there something that broke for you recently?


Note to self:

@corasaniti
Copy link
Author

Could you write the released version on the web page with the graphic? Thanks

@ansemjo
Copy link
Owner

ansemjo commented May 7, 2022

I've started a changelog and the DockerHub description now points to the README and CHANGELOG files in this repository. I won't update the image description on DockerHub for every new release.

The latest tagged release can be found under Releases on GitHub or in the list of package versions, since the images released to ghcr.io will always be the same as those pushed to DockerHub.

@ansemjo ansemjo closed this as completed May 7, 2022
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

2 participants