docs(process): correct the "CHANGELOG is auto-generated" claim + fix v1.0.2 date & stale release grouping (#178)#311
Merged
Conversation
…v1.0.2 date and stale release grouping (#178) The CHANGELOG is hand-maintained (keep-a-changelog `## [Unreleased]` buffer, finalised at release time per RELEASING.md) — there is no changelog tooling in the repo. But AGENTS.md claimed "The CHANGELOG is generated from these [conventional commits]", which is false and contradicts RELEASING.md. - AGENTS.md: replace the false "generated" claim with an accurate description of the manual keep-a-changelog process; point to RELEASING.md; note that adopting changelog tooling is tracked separately (#310). - CHANGELOG.md: fix the v1.0.2 date 2026-03-17 → 2026-02-17 to match the actual GitHub release (published_at 2026-02-17); the wrong date had put v1.0.2 out of chronological order after v1.0.3/v1.0.4. Annotate the genuinely-empty 0.4.8/0.4.9 releases so a reader doesn't mistake them for dropped content. Record this fix under `## [Unreleased]` → Docs. - RELEASING.md: step 3 told the releaser to keep the older `Features`/`Bug Fixes`/`Security`/`Chore` grouping, but the `[Unreleased]` buffer contributors actually fill uses keep-a-changelog headings — align it (same doc-vs-reality defect class as the AGENTS.md claim). Adopting real changelog automation (changelogen / release-it) is the larger, optional half of #178 and is tracked in the follow-up #310. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01H6MQtPUx9MZjXY2rbLZhbv
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
2 participants
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.
Closes #178. Automation follow-up tracked in #310.
Problem
AGENTS.mdclaimed "The CHANGELOG is generated from these [conventional commits]" — but there is no changelog tooling in the repo (verified: nochangelogen/release-it/conventional-changelog/standard-versionanywhere in package.json/scripts/workflows), andRELEASING.mditself describes a manual finalise-the-changelog step. The claim was false and self-contradictory. #178 also flagged thev1.0.2entry dated2026-03-17while the GitHub release was published2026-02-17, and empty0.4.8/0.4.9entries.Fixes (docs-only)
## [Unreleased]→ Added/Changed/Fixed/Docs, finalised at release per RELEASING.md); breadcrumb to the automation follow-up (release: adopt changelog automation (changelogen / release-it) so CHANGELOG and GitHub release notes share one source #310).v1.0.2date2026-03-17→2026-02-17(matches the release'spublished_at; restores chronological order v1.0.1 → v1.0.2 → v1.0.3). Annotate the genuinely-empty0.4.8/0.4.9releases (_No user-facing changes (empty release)._) so they aren't misread as dropped content. Record the fix under## [Unreleased]→ Docs.Features/Bug Fixes/Security/Choregrouping, but the[Unreleased]buffer uses keep-a-changelog headings; aligned it (same doc-vs-reality defect class release: CHANGELOG is hand-written although AGENTS.md claims it is generated — adopt changelog automation #178 targets — surfaced by an adversarial doc-audit reviewer).Verification
pnpm run lint:md— 0 errors (21 files)node scripts/docs-lint.mjs --strict— 0 errors, 0 warnings (editing.mddocs doesn't age any content page'saudited:)packages/jssdk-nuxt/src/module.ts#119 token, CHANGELOG date order).Reviewed by a 5-perspective pass (fact-check, consistency/docs, scope/bookkeeping, adversarial doc-audit, follow-up integrity) — all SHIP; the RELEASING.md grouping fix was folded in from the adversarial reviewer.
🤖 Generated with Claude Code
https://claude.ai/code/session_01H6MQtPUx9MZjXY2rbLZhbv
Generated by Claude Code