docs(docker): add a Docker Hub README and sync it on publish - #188
Merged
Conversation
The Docker Hub page was empty, so the only thing a visitor could do with the image was guess. Its audience is not the one the repository README serves: an operator deploying the image needs the required variables, the tag meanings and a compose file that works on the first try, not the tech stack or the test commands. Hence a separate document rather than a link to the existing one. The publish workflow syncs it after a successful push. The step is marked continue-on-error on purpose: the image is already published by then, and a description that fails to update must not turn a good publish into a red run.
This was referenced Sep 2, 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
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.
The Docker Hub page is empty, so the only thing a visitor can do with the image is guess.
Why a separate document
Its audience is not the one the repository README serves. Someone landing on Docker Hub is about to run the image in production and needs three things: the required variables, what the tags mean, and a compose file that works on the first try. The tech stack, the test commands and the contribution guide belong on GitHub.
What lands
docker/README.hub.md: tags, a ready-to-run compose stack with PostgreSQL, the required and optional variables, and the operating notes that are easy to get wrong (concurrent migrations across replicas, the health endpoint, the external scheduler,BETTER_AUTH_URLbehind a reverse proxy).continue-on-error: the image is already pushed by the time it runs, so a description that fails to update must not turn a good publish into a red run.Note
The description API may reject a scoped access token. If the step reports a failure on the next publish, the token needs wider permissions, or the page can be filled by hand. The image push itself is unaffected either way.