Use a GitHub Action to update the Docker Hub description #213
Conversation
This file contains 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
Use the peter-evans/dockerhub-description Action to update the Docker Hub description instead of a bash script.
Instead of updating the description whenever the `build` workflow is run we will only update the description on `push` events to the `develop` branch. This will ensure that only approved edits are pushed to Docker Hub.
mcdonnnj
added
improvement
dv4harr10
approved these changes
Feb 10, 2025
mcdonnnj
added
the
kraken 🐙
6 tasks
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.
🗣 Description
This pull request updates the
buildworkflow to use the peter-evans/dockerhub-description Action to update the image description on Docker Hub and to only do so on apushevent to thedevelopbranch.💭 Motivation and context
It makes sense to leverage an Action for work being done in GitHub Actions when possible. It also makes sense to limit updates to the Docker Hub description to changes that have moved through the approval process.
🧪 Testing
Automated tests pass. I also verified that the
Update the Docker Hub descriptionstep did not run.✅ Pre-approval checklist