Fix stale JAR filename in documentation examples - #15
Conversation
README.md, USER_GUIDE.md and CONFIG.md documented `java -jar` invocations against `target/gh-backup-1.0.0.jar`, but the project version in pom.xml is 2.0.0-SNAPSHOT-8-8-2026 and no <finalName> is configured, so the build produces `target/gh-backup-2.0.0-SNAPSHOT-8-8-2026.jar`. Every documented invocation failed with "Unable to access jarfile" when followed literally. The 23 stale references are updated to the artifact the build actually produces, matching the convention already used in COMMANDS.md and Dockerfile. Closes #14 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Self-review rubricScored adversarially against the diff and command output, not against intent.
FindingsOne substantive finding was raised, and it is a judgment call rather than a defect in this diff:
Matching the established convention is nonetheless the right call for this PR: deviating from it would leave the five files inconsistent with each other, and the alternatives (a No rubric item required a code change, so no follow-up commit was pushed. This comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
Summary
java -jarexamples inREADME.md,USER_GUIDE.mdandCONFIG.mdreferencedtarget/gh-backup-1.0.0.jar, a file the build does not produce. The project version inpom.xmlis2.0.0-SNAPSHOT-8-8-2026and no<finalName>is configured under<build>, somvn clean packageemitstarget/gh-backup-2.0.0-SNAPSHOT-8-8-2026.jar— the same nameDockerfileline 18 copies. Anyone following the documented quick start was met withError: Unable to access jarfile target/gh-backup-1.0.0.jar.README.md(including the build step that states where the executable JAR is created), 9 inUSER_GUIDE.md, and 10 inCONFIG.md.COMMANDS.mdandDockerfile— the full version string rather than a placeholder — is matched, soCOMMANDS.mdneeded no change.### Fixedentry is added to the[Unreleased]section ofCHANGELOG.md.No source, configuration, or workflow files are touched; this change is documentation-only.
Test plan
mvn test— BUILD SUCCESS, 54 tests executed, 0 failures, 0 errors, 1 skipped (the skip is pre-existing onmainand unrelated to this change)grep -rn "gh-backup-1.0.0"across all documentation,Dockerfileanddocker-compose.ymlreturns only the intentional mention inside the newCHANGELOG.mdentrypom.xml(<artifactId>gh-backup</artifactId>,<version>2.0.0-SNAPSHOT-8-8-2026</version>, no<finalName>) and againstDockerfileline 18Note on verification scope: because the change is documentation-only, the Maven test suite verifies nothing about the corrected text itself. The correctness of the new filename rests on the
pom.xml/Dockerfilecross-check recorded above rather than on the green build.Issues deferred this cycle
LICENSEfile) — deferred because resolving it requires choosing a copyright holder and year, a maintainer/legal decision that an autonomous cycle should not make unilaterally.docker-entrypoint.shhas no automated test) — deferred because the fix necessarily modifies.github/workflows/build.ymlto wire the new test into CI, a path that this loop treats as ineligible for autonomous merge; it is better handled where a human can approve the CI change directly.Closes #14
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson