Sync README to Docker Hub overview on publish - #10
Merged
Merged
Conversation
The Docker Hub repo showed "No overview available". Add a peter-evans/dockerhub-description step to the merge job (main only, when Hub secrets are set) that pushes README.md and a short description. Screenshot <img> tags now use absolute raw.githubusercontent.com URLs: the action's url completion only rewrites markdown links/images, so relative HTML image paths would render broken 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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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 does this change?
The Docker Hub repository shows "No overview available". This PR adds a
peter-evans/dockerhub-description@v5step at the end of themergejob. On each publish frommainit pushesREADME.mdas the Docker Hub overview and sets the short description to the README tagline.github.ref == 'refs/heads/main'), so a release tag or a manual run from another ref can't overwrite the overview with a different README.README.md: the merge job never checked out the repo before, because it only needs the image digests.enable-url-completion: trueturns relative markdown links (docker-compose.yml,LICENSE,CONTRIBUTING.md, …) into full GitHub URLs, since Docker Hub can't resolve relative paths.<img src>values now use fullraw.githubusercontent.comURLs. The action's URL rewriting only handles markdown syntax, not HTML<img>tags, so relative paths would show as broken images on Docker Hub. The new URLs work on GitHub too; I checked that all three load.Reviewer notes
DOCKERHUB_TOKENis Read & Write only, image mirroring still works but this step will fail with a 403. In that case, create a new token with that scope and update the secret.DOCKERHUB_USERNAME/model-workshop-manager), the same way the mirror step builds it.main.Related issue
Follow-up to #8 / #9.
Checklist
npm run lint:fixandnpm run fmtat the repo root (fmt:checkpasses)npm run typecheckandnpm run buildpass: n/a, no app code changedScreenshots
n/a