Skip to content

List minecraft-versions.json in the README's project layout - #46

Merged
dmccoystephenson merged 1 commit into
mainfrom
feature/readme-layout-versions-file
Nov 16, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
feature/readme-layout-versions-file

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

  • README.md → Project Layout now lists minecraft-versions.json. The README's Supported Minecraft Versions section tells contributors to add a version to that file, and both the Build workflow (check_api_compat.py --versions minecraft-versions.json) and DocumentationTest.versionListsMatchMinecraftVersionsJson read it, yet the layout listed only Main.java, plugin.yml and src/test/java/.
  • CHANGELOG.md gains a bullet under ## [Unreleased] → ### Fixed.

This was the only drift found by a documentation accuracy sweep (Stage A) of README.md, USER_GUIDE.md, COMMANDS.md, CONFIG.md, CHANGELOG.md, CONTRIBUTING.md and plugin.yml against Main.java, plugin.yml, pom.xml, minecraft-versions.json and the three workflows at 4485d8b.

No tracking issue — gap found during triage. #45 states that the README's Project Layout already lists minecraft-versions.json; it did not, and after this PR it does, so the change suggested there for .github/copilot-instructions.md would match the README.

Validation

  • mvn -o clean package on this branch: Tests run: 13, Failures: 0, Errors: 0, Skipped: 0, BUILD SUCCESS. The same build passed on main before the change.
  • Every claim in the new line was checked against source: .github/workflows/build.yml passes --versions minecraft-versions.json to the API check, and DocumentationTest line 46 loads the file and compares it with the version lists in README.md and USER_GUIDE.md.
  • Only Markdown changed, so no on-server check applies and the Dev Release workflow ignores this merge.

Open issues deferred this cycle

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

The Supported Minecraft Versions section tells contributors to edit
minecraft-versions.json, but Project Layout listed only the source,
the manifest and the tests.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric (performed inline; Copilot reviewer could not be added: Could not resolve user with login 'copilot'):

  • Scope: PASS — git diff --name-only origin/main...HEAD lists only README.md and CHANGELOG.md, with one added line in each.
  • Validation-new: PASS — DocumentationTest still passes (Tests run: 13, Failures: 0). The new README line's claims were checked against .github/workflows/build.yml (--versions minecraft-versions.json) and DocumentationTest.java:46 (loadConfiguration(new File("minecraft-versions.json"))).
  • Validation-fix: not applicable — documentation-only; no behaviour was fixed.
  • Sibling structure: PASS — the new bullet uses the same `path` – description form as the three bullets above it.
  • Sibling renames: not applicable — nothing was renamed.
  • Docs: PASS — CHANGELOG.md has a ### Fixed bullet under ## [Unreleased]. USER_GUIDE.md, COMMANDS.md, CONFIG.md and CONTRIBUTING.md do not describe the project layout, so none of them needed a change.
  • Issue resolution: not applicable — no Closes. copilot-instructions Project Structure lists only Main.java, not plugin.yml, the tests or minecraft-versions.json #45 was deliberately left open because it needs a maintainer's approval to edit .github/copilot-instructions.md.
  • Manual validation / CI: PASS — mvn -o clean package gave BUILD SUCCESS locally, and the Build check (Maven build plus the Bukkit API check) passed on the PR head.
  • Manifest/command declaration and main-class resolution: PASS — unchanged. PluginManifestTest passes.
  • No stack change: PASS — pom.xml, the sources and the workflows are untouched.
  • No harness leakage: PASS — no .claude/ path in the diff.
  • Do-not-auto-merge paths: none matched. No workflow, plugin.yml, Java source, .github/copilot-instructions.md or LICENSE is touched, and no file loses lines.

Observation outside the diff: README.md:63's src/test/java/ bullet ("tests of the packaged manifest, of the /fly handler, and of the docs against their sources") remains accurate against the three test classes.

No blocking findings. The PR is considered merge-ready.

This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 9375898 into main Nov 16, 2026
1 check passed
@dmccoystephenson
dmccoystephenson deleted the feature/readme-layout-versions-file branch November 16, 2026 04:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant