ci: sync README to the Docker Hub repository overview#314
Merged
Conversation
Add a `Docker Hub description` workflow that pushes the README and a short description to the `ionalpha/flynn` Docker Hub repository whenever the README changes on main, and on manual dispatch. GoReleaser publishes image bytes on a tag but does not update these text fields, so without this the Docker Hub overview stays empty and drifts from the README. It reuses the existing `DOCKERHUB_USERNAME` and `DOCKERHUB_TOKEN` secrets and enables URL completion so the README's repo-relative links resolve on Docker Hub.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add a
Docker Hub descriptionworkflow that syncs the README and a short description to theionalpha/flynnDocker Hub repository. It runs whenREADME.mdchanges onmainand on manual dispatch, reusing the existingDOCKERHUB_USERNAMEandDOCKERHUB_TOKENsecrets, with URL completion enabled so repo-relative links resolve on Docker Hub.Why
Tagged releases publish the container image, but nothing updates the Docker Hub repository overview or short description, so they start empty and drift from the README. This keeps the public Docker Hub page in step with the README automatically.
How to verify
On manual dispatch (or a README change landing on
main), the workflow succeeds and the Docker Hub page athub.docker.com/r/ionalpha/flynnshows the README as its overview and the short description. The action is pinned by commit SHA.Notes for reviewers
Docker Hub overview/short-description updates use the existing read/write access token. If Docker Hub rejects a token for the description endpoint, the fallback is a
DOCKERHUB_PASSWORDsecret; current tokens with read/write scope are expected to work.