Repository navigation
Check the docs against the files they copy from - #43
Merged
Merged
Conversation
The supported versions, the /fly messages and the permission details are copied by hand into the Markdown docs, and nothing compared the copies with minecraft-versions.json, Main.java or plugin.yml. DocumentationTest reads both sides and fails the build when they disagree. Also corrects the README, which said the suite reads the plugin.yml packed into the jar: surefire runs before the jar is built. Closes #42 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
Self-reviewReviewed at The rubric below is scored against the Maven suite and the
Findings, none blocking:
This comment 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
DocumentationTestis added. It reads the Markdown docs alongsideminecraft-versions.json,Main.javaandplugin.yml, and fails the build when the version lists,/flymessages orFlyCommand.flypermission details disagree. The strings are taken from the sources, so the test needs no editing when a message changes.plugin.yml"packed into the jar". The build log shows surefire running beforemaven-jar-plugin, so no jar exists at that point.Closes #42
Validation
mvn -B clean packageon the PR head:Tests run: 13, Failures: 0, Errors: 0, Skipped: 0,BUILD SUCCESS(10 existing tests, 3 new).The new tests were confirmed able to fail. Each mutation below was applied alone,
mvn clean testwas run, and the file was restored:minecraft-versions.jsongains26.4versionListsMatchMinecraftVersionsJsonminecraft-versions.jsonloses26.3versionListsMatchMinecraftVersionsJsonREADME.mdlist loses26.3versionListsMatchMinecraftVersionsJsonUSER_GUIDE.mdversion typoversionListsMatchMinecraftVersionsJsonMain.javadocsQuoteEveryMessageTheCommandSends, plus two existingFlyCommandTesttestsCOMMANDS.mddocsQuoteEveryMessageTheCommandSendsREADME.mddocsQuoteEveryMessageTheCommandSendsplugin.ymldocsNameEveryPermissionTheCommandChecks, plusPluginManifestTest.declaresTheFlyPermissionUSER_GUIDE.mddocsNameEveryPermissionTheCommandChecksCOMMANDS.mddocsNameEveryPermissionTheCommandChecksCONFIG.mddocsNameEveryPermissionTheCommandChecksNine of the eleven were not caught by the existing test suite.
No on-server recipe applies, because no plugin behaviour changes.
Known limit: the message and permission checks cover only strings
Main.javapasses as literals. A message built at runtime would not be seen;Main.javahas none today.Side effect of merging
src/test/**is not in thepaths-ignorelist ofdev-release.yml, so merging republishes thedevprerelease, built from unchanged plugin code.Deferred issues
pom.xmlis still at1.0.1, andgit ls-remote --tagsshows onlyv1.0.0anddev.This 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