feat: add automatic Docker Hub README sync #286
Merged
Conversation
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
- Add peter-evans/dockerhub-description action to Docker workflow - Automatically updates Docker Hub README and description on each release - Uses existing DOCKERHUB_USERNAME and DOCKERHUB_TOKEN secrets - Syncs main README.md to Docker Hub repository page Closes #285
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.
Summary
This PR adds automatic syncing of the README to Docker Hub whenever we create a new release.
Problem
As noted in #285, the Docker Hub README was outdated and had to be manually updated. This creates extra work and can lead to users seeing stale documentation.
Solution
Added the
peter-evans/dockerhub-descriptionGitHub Action to the Docker workflow. This action will:Changes
.github/workflows/docker.ymlDOCKERHUB_USERNAMEandDOCKERHUB_TOKENsecrets (already configured)README.mdto Docker Hub repository descriptionTesting
This will be tested on the next release. The action is well-maintained and widely used in the community.
Benefits
Closes #285