Fail the build when a documented JAR name drifts from the pom version - #27
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (anchored on CI run 36230964635:
Judgment call (not blocking):
Summary: the guard is in place and verified both ways; ready to merge under the dispatch's merge authorization. This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
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
DocumentationVersionTestis added. It reads the top-level<version>frompom.xml, scansREADME.md,USER_GUIDE.md,CONFIG.md,COMMANDS.mdandDockerfilefor everygh-backup-<version>.jarreference, and failsmvn test(so alsomvn clean verifyin thebuildCI job) with afile:linelist of any reference naming a different version. A second test confirms the release workflow'starget/gh-backup-*.jarglob is not matched.CHANGELOG.mdis excluded on purpose, since it records the names of past artifacts (e.g.gh-backup-1.0.0.jar).CONTRIBUTING.mdnotes the check next to the existing testing instructions;CHANGELOG.mdgains an[Unreleased]entry.Of the three directions listed in #16, the first (a check that keeps the copy-pasteable literal names) was taken. It changes neither the artifact name,
pom.xml, the release workflow, nor any workflow file, so the other two directions (<finalName>, placeholder names) remain open to the maintainer later. It is implemented as a JUnit test rather than a workflow step, so no.github/workflows/*change is needed and it also runs for anyone runningmvn testlocally.The new test does not mirror a main-source class 1:1, because it guards repository files rather than a production class; it otherwise follows the
test<Subject>_<Scenario>naming.Closes #16
Skipped issues
LICENSEfile): left open — choosing the copyright holder and year is a licensing decision flagged for the maintainer in the issue itself.Test plan
mvn test— 86 tests run, 0 failures, 1 skipped (pre-existing)README.md:21temporarily changed togh-backup-1.0.0.jar,DocumentationVersionTestfailed withREADME.md:21 names gh-backup-1.0.0.jar; with the change reverted it passesbuildanddocker-buildjobs greenThis PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson