Skip to content

Record the unlogged changes since 1.0.0 in the changelog - #44

Merged
dmccoystephenson merged 1 commit into
mainfrom
feature/changelog-unreleased-gaps
Nov 12, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
feature/changelog-unreleased-gaps

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

A documentation accuracy sweep (Stage A) found no drift between the docs and the source. USER_GUIDE.md, COMMANDS.md, CONFIG.md, README.md and CONTRIBUTING.md were each checked against Main.java, plugin.yml, pom.xml, minecraft-versions.json and the three workflows. The one gap was in CHANGELOG.md: five merges since the 1.0.0 release changed what users or contributors see but have no ## [Unreleased] entry, although every other doc change since #37 has been logged there. The section even listed a fix to the README image's caption (#38) without ever listing the image.

Entries added under ## [Unreleased]:

Each entry was written from git show of the merge it cites, not from the PR title alone.

No tracking issue: the gap was found during the sweep.

Validation

Issues not picked 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

Five merges since the 1.0.0 release changed what users or contributors
see without a CHANGELOG entry: the README image (#29), the CONTRIBUTING
build step (#28), the dev prerelease wording (#33), the CONFIG.md
permission text (#34) and the PluginDescriptionFile manifest tests (#41).
The Unreleased section even logged a fix to the image's caption without
ever logging the image. Add the missing entries.

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

Copy link
Copy Markdown
Member Author

Self-review (rubric)

The Copilot reviewer could not be added (Could not resolve user with login 'copilot'), so the review was carried out inline in the dispatching session.

  • Scope: PASS. git diff --name-only origin/main...HEAD lists only CHANGELOG.md (+7/-0). No formatting churn in existing entries.
  • Validation-new: PASS. Each new entry was checked against the diff of the merge it cites: 48bd1f7 (Add a hero image of real in-game output to the README #29) adds docs/images/fly.png and the README image; 06467e1 (Tell contributors to build and test before opening a PR #28) adds step 4 to CONTRIBUTING.md; 98a0464 (State exactly which pushes republish the dev prerelease #33) changes the README Releases sentence to "anything other than Markdown files or LICENSE", which matches paths-ignore: '**.md', 'LICENSE' in dev-release.yml; 1a1e71f (Say how the fly permission is granted in CONFIG.md #34) rewrites CONFIG.md; 353d7f9 (Check plugin.yml with the parser a server uses #41) moves PluginManifestTest to PluginDescriptionFile and adds the name and api-version assertions.
  • Validation-fix: N/A. No bug fix to code. The State exactly which pushes republish the dev prerelease #33 entry sits under Fixed because it corrects an imprecise README claim.
  • Sibling structure: PASS. The new ### Changed subsection sits between ### Added and ### Fixed, in Keep a Changelog order and the same order as the [1.0.0] section.
  • Docs: PASS. A Stage A sweep of README, USER_GUIDE, COMMANDS, CONFIG, CONTRIBUTING and .github/copilot-instructions.md against Main.java, plugin.yml, pom.xml, minecraft-versions.json and the workflows found no other drift.
  • Issue resolution: N/A. No Closes; the gap was found during the sweep.
  • Manifest / command declaration / main-class: PASS (unchanged). PluginManifestTest 6/6 passed locally (main, name, api-version, Fly command, FlyCommand.fly default op).
  • Override annotations: PASS (unchanged). onEnable, onDisable and onCommand each carry @Override in Main.java.
  • No stack change: PASS. Only Markdown changed.
  • Manual validation / CI: PASS. Local mvn -B clean package ran 13 tests (Documentation 3, FlyCommand 4, PluginManifest 6) with 0 failures and 0 errors. PR build check: pass (21s). Neither reads CHANGELOG.md, so they only show that nothing else regressed. The entries themselves were verified by hand against the diffs above.
  • No harness leakage: PASS. No .claude/ path in the diff.

Judgment call (not blocking):

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 4485d8b into main Nov 12, 2026
1 check passed
@dmccoystephenson
dmccoystephenson deleted the feature/changelog-unreleased-gaps branch November 12, 2026 05:41
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