feat: mirror README.md on the PowerShell Gallery package page - #85
Merged
Merged
Conversation
PowerShell Gallery renders a module's README.md automatically if it's present in the published package, but Publish-Module only packages PiHoleShell/, and README.md lived at the repo root, so the Gallery page never showed it. The release workflow now copies README.md into PiHoleShell/ before zipping/publishing (gitignored locally, since it's a build-time artifact, never meant to be committed). Also switches the two screenshot images to absolute GitHub raw URLs instead of repo-relative paths, since a relative path only resolves correctly when viewed from the repo root and would render as a broken image on the Gallery page. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
feat: mirror README.md on the PowerShell Gallery package page
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
1 participant
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
PowerShell Gallery renders a module's
README.mdautomatically if it's present in the published package — butPublish-Moduleonly packages thePiHoleShell/folder, andREADME.mdlives at the repo root, so the Gallery page has never shown it.CreateRelease.ymlnow copiesREADME.mdintoPiHoleShell/right before zipping/publishing, so both the GitHub release zip and the Gallery package include it. That copy is gitignored locally since it's purely a build-time artifact.<img>tags to absoluteraw.githubusercontent.comURLs instead of repo-relative paths — a relative path only resolves when viewed from the repo root on GitHub, and would render as a broken image on the Gallery page.Test plan
git statusInvoke-ScriptAnalyzer -Path .\PiHoleShell -Recurse— no findings🤖 Generated with Claude Code