Skip to content

Fix: make Docker Hub README sync non-fatal and run it after the version report #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gambe94 merged 1 commit into from
Jul 12, 2026
Merged

Fix: make Docker Hub README sync non-fatal and run it after the version report #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions .github/workflows/docker-build-test-push.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,18 +228,6 @@ jobs:
DIGEST: ${{ steps.push.outputs.digest }}
run: cosign sign --yes "${{ inputs.dockerhub-username }}/${{ inputs.image-name }}@${DIGEST}"

# Requires a read/write Docker Hub token (read-only tokens cannot update
# repository descriptions).
- name: Sync README to Docker Hub
if: ${{ inputs.image-description != '' }}
uses: peter-evans/dockerhub-description@432a30c9e07499fd01da9f8a49f0faf9e0ca5b77 # v4.0.2
with:
username: ${{ inputs.dockerhub-username }}
password: ${{ secrets.dockerhub-token }}
repository: ${{ inputs.dockerhub-username }}/${{ inputs.image-name }}
short-description: ${{ inputs.image-description }}
readme-filepath: ${{ inputs.context }}/README.md

# Tool versions are read from the built image (source of truth, not the
# Dockerfile) and aggregated by the caller's release job.
- name: Build version report
Expand Down Expand Up @@ -270,3 +258,19 @@ jobs:
name: version-report-${{ inputs.image-name }}
path: version-report-${{ inputs.image-name }}.md
retention-days: ${{ inputs.artifact-retention-days }}

# Cosmetic; must never fail the release path (v1.7.0 lesson: a Forbidden
# here skipped the version report and the caller's release job).
# Docker Hub's description PATCH needs a token with Read/Write/Delete
# scope (or the account password) — a push-scoped read/write token gets
# 403 Forbidden even though docker push works.
- name: Sync README to Docker Hub
if: ${{ inputs.image-description != '' }}
continue-on-error: true
uses: peter-evans/dockerhub-description@432a30c9e07499fd01da9f8a49f0faf9e0ca5b77 # v4.0.2
with:
username: ${{ inputs.dockerhub-username }}
password: ${{ secrets.dockerhub-token }}
repository: ${{ inputs.dockerhub-username }}/${{ inputs.image-name }}
short-description: ${{ inputs.image-description }}
readme-filepath: ${{ inputs.context }}/README.md
Loading