Add dev release channel, auto-generated release notes, and README automation - #83
Merged
Merged
Conversation
Adds a workflow that zips the module and publishes it as a pre-release tagged 'dev-latest' on every push to develop, so builds can be tested before they're promoted to main. The release is overwritten each time (old dev-latest release/tag deleted first) and the module version is stamped as 0.0.0-dev.<short-sha> so it's obviously distinct from a real PowerShell Gallery release. Does not touch the PowerShell Gallery publish step, which only runs from the develop->main release workflow. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
ci: publish rolling dev builds to GitHub Releases
The Create GitHub Release step didn't pass a body or notes option, so every release (including v0.0.22) was published with an empty description. generate_release_notes: true has GitHub auto-build a "What's Changed" section listing every PR merged since the previous tag, with authors and a compare link, so releases document themselves without per-release manual work. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
fix: auto-generate GitHub release notes
Adds tools/Update-ReadmeCommandReference.ps1, which builds the Command Reference tables in README.md from the module's actual exported commands (PiHoleShell.psm1), not just what's documented by hand — this is how we previously found two public functions that weren't exported and silently undocumented. Each entry's description comes from the function's own comment-based help synopsis, falling back to "_No description yet_" for the several functions whose synopsis is just a bare doc URL. The 🚧 flag is derived from a '#Work In Progress' marker in the source file. A new workflow, SyncReadmeCommandReference.yml, runs the generator on every develop->main pull request and commits the result back to the develop branch if it drifted, so the README can't go stale. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…sync docs: auto-generate README command reference from exported functions
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
dev-latestpre-release published to GitHub Releases on every push todevelop, so builds can be tested before promotion tomain. Never touches the PowerShell Gallery — that stays exclusive to thisdevelop->mainrelease workflow.CreateRelease.ymlnow setsgenerate_release_notes: true, so every future release gets a "What's Changed" section listing merged PRs automatically. Also backfilled the previously-emptyv0.0.22release notes.tools/Update-ReadmeCommandReference.ps1rebuilds the README's Command Reference tables from the module's actual exported functions, and a new workflow runs it on everydevelop->mainPR so the docs can't silently drift from the code.Test plan
v0.0.22's backfilled release notes render correctly on GitHub-Checkmode correctly detects drift🤖 Generated with Claude Code