Skip to content

Feature: publish the Docker Hub description from README.md - #22

Merged
SandObserver merged 1 commit into
mainfrom
feat/dockerhub-description
Aug 10, 2026
Merged

SandObserver merged 1 commit into
mainfrom
feat/dockerhub-description

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • Add scripts/dockerhub-description.js, which rewrites README.md into the text Docker Hub renders: the centered HTML header is replaced with a markdown equivalent, repo-relative link and image targets become blob/raw URLs, bare #anchor links point at the GitHub README, the table of contents is dropped, and fenced code samples name sandobserver/stackyard instead of ghcr.io/sandobserver/stackyard.
  • Throw rather than emit when the result exceeds Docker Hub's 25,000 character limit, which the API otherwise truncates silently, or when the README has no ## heading.
  • Add two release-workflow steps, gated on the existing Docker Hub registry choice and on is-prerelease.js reporting a stable tag, that generate the description and push it with peter-evans/dockerhub-description@v4.0.2 (SHA-pinned), including the short description.
  • Keep prose recommending ghcr.io as the registry the release signature covers; only code samples switch registry.

Testing
All green. Added 7 tests covering link absolutisation, image rendering, HTML removal, registry substitution, section handling, and both failure modes.

Checklist

  • Stays within the project constraints: one container, no runtime dependencies, no build step (see CONTRIBUTING.md).
  • Tests added or updated for new logic, and the full suite, lint, and typechecks pass.
  • Docs updated if behavior or configuration changed.
  • CHANGELOG.md updated under Unreleased if the change is user-visible.

The Docker Hub repository page was set by hand and drifted from the README.
Copying the README across verbatim is not an option: its links are repo-relative
and resolve against hub.docker.com, and its centered HTML header is rendered as
literal markup.

Generate the description at release time instead, from README.md, and push it
after a stable tag's image. Prereleases leave the page alone.
@SandObserver SandObserver added the github_actions Pull requests that update GitHub Actions code label Aug 10, 2026
@SandObserver
SandObserver merged commit 5e65ac9 into main Aug 10, 2026
4 checks passed
@SandObserver
SandObserver deleted the feat/dockerhub-description branch August 10, 2026 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant