Repository navigation
Feature: publish the Docker Hub description from README.md - #22
Merged
Merged
Conversation
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.
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
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
scripts/dockerhub-description.js, which rewritesREADME.mdinto the text Docker Hub renders: the centered HTML header is replaced with a markdown equivalent, repo-relative link and image targets becomeblob/rawURLs, bare#anchorlinks point at the GitHub README, the table of contents is dropped, and fenced code samples namesandobserver/stackyardinstead ofghcr.io/sandobserver/stackyard.##heading.is-prerelease.jsreporting a stable tag, that generate the description and push it withpeter-evans/dockerhub-description@v4.0.2(SHA-pinned), including the short description.ghcr.ioas 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