Publish Docker Hub overview on each release#21
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR versions the Docker Hub repository overview in-repo and updates the publish workflow so the Docker Hub full_description is automatically kept in sync on each GitHub Release.
Changes:
- Added
docker/README.mdcontaining the Docker Hub overview (usage, well-known paths, caching guidance, SEP-58 notes, tag conventions). - Added a
descriptionjob to.github/workflows/publish.ymlto PATCH Docker Hubfull_descriptionfromdocker/README.mdafter publishing manifests. - Documented
docker/README.mdin the top-levelREADME.mdrepo layout table.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
README.md |
Adds docker/README.md to the repo layout documentation. |
docker/README.md |
Introduces the Docker Hub overview content to be published as full_description. |
.github/workflows/publish.yml |
Adds an automated Docker Hub description update job and wires it into the workflow completion chain. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
leighmcculloch
approved these changes
Jun 9, 2026
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.
Adds a
docker/README.mdthat serves as the Docker Hub repository overview, and wires the publish workflow to push it to the repository'sfull_descriptionon each release.What changed
docker/README.mdwith a Stellar CLI overview: quick start, the four well-known container paths (/source,/config,/data,/stellar), cargo-cache reuse guidance, SEP-58 verifiable-builds instructions, and image tag conventions.descriptionjob in.github/workflows/publish.ymlthat logs into the Docker Hub API and PATCHes the repository'sfull_descriptionfromdocker/README.md. It runs aftermanifest, is gated todocker.io/registries (skipped for forks publishing elsewhere), and is added to the final job'sneeds.docker/README.mdin the top-levelREADME.mdfile table.Why
Keeps the Docker Hub overview versioned in the repo and automatically in sync with each release, rather than maintained by hand in the Docker Hub UI.
Verification