Skip to content

chore: versioning hygiene pass#88

Merged
PAMulligan merged 1 commit into
mainfrom
chore/versioning-audit-flavian
May 28, 2026
Merged

chore: versioning hygiene pass#88
PAMulligan merged 1 commit into
mainfrom
chore/versioning-audit-flavian

Conversation

@PAMulligan
Copy link
Copy Markdown
Collaborator

Summary

Versioning hygiene pass: backfilled missing v1.1.0 section in CHANGELOG.md and drafted canonical milestone description proposals. Several items intentionally not applied because Flavian's existing setup differs from the canonical Nerva pattern — see ambiguity notes below for human review.

Latest tag

v1.1.0 (tagged 2026-05-07). Previous tag: v1.0.0.

Sub-task status

  • Sub-task 1 — Reconcile package.json with latest tag — Ambiguity flagged, NOT applied. package.json version is 0.0.0, latest tag is v1.1.0. However, package.json explicitly documents in its description field: "Source of truth for the repository version is git tags + .release-please-manifest.json, not this file." The .release-please-manifest.json correctly tracks 1.1.0. Bumping package.json from 0.0.0 would contradict a deliberate project convention. Question for reviewer: should package.json.version be updated to 1.1.0 (overriding the documented convention), kept at 0.0.0 (preserving the release-please-manifest-as-source-of-truth design), or should the documented description be reworded?
  • Sub-task 2 — Milestone descriptions — Applied. One open milestone (v2.0.0). Current description is not in canonical format; proposal written to docs/milestones-proposed.md. No GitHub milestones edited.
  • Sub-task 3 — CHANGELOG audit — Applied. Backfilled ## [1.1.0] - 2026-05-07 section with Added / Changed / Fixed subsections summarized from 44 closed issues in milestone v1.0.0 — Initial Public Release #1 (cross-referenced against git log v1.0.0..v1.1.0). Existing ## [Unreleased] and ## [1.0.0] entries left untouched. Updated comparison links at the bottom of the file to add the v1.1.0 entry. No closed milestone is missing a CHANGELOG section; no tag is missing a milestone.
  • Sub-task 4 — Release config (match Nerva canonical) — NOT applied, ambiguity flagged. Flavian uses release-please (configured via .github/workflows/release-please.yml, release-please-config.json, and .release-please-manifest.json), not commit-and-tag-version like Nerva. Both tools serve the same purpose (automated semver bumping from conventional commits). Adding Nerva's release:* scripts, the commit-and-tag-version devDependency, and .versionrc.json would create two competing release tools and likely break the existing release-please CI workflow. Question for reviewer: is Flavian intentionally on release-please, or should we migrate to commit-and-tag-version to match Nerva (which would require removing the release-please workflow and migrating .release-please-manifest.json state)?

Files changed

  • CHANGELOG.md — appended v1.1.0 section, updated bottom comparison links
  • docs/milestones-proposed.md — new file with proposed canonical v2.0.0 milestone description

Ambiguities for reviewer

  1. package.json version policy — see Sub-task 1 above. Two reasonable answers; please pick one.
  2. Release tool choice — see Sub-task 4 above. Migrating release-please → commit-and-tag-version is a non-trivial decision and outside the safe scope of a hygiene pass.
  3. No discrepancies between tags and milestones detected: v1.0.0 and v1.1.0 tags both exist; milestone v1.0.0 — Initial Public Release #1 (v1.1.0) is closed; milestone Flavian Roadmap — Where We're Headed #2 (v2.0.0) is open and expected.

Test plan

  • Reviewer confirms package.json version policy
  • Reviewer confirms release tooling direction
  • Reviewer reviews v1.1.0 CHANGELOG entries for accuracy (44 closed issues summarized)
  • Reviewer reviews proposed v2.0.0 milestone description in docs/milestones-proposed.md

Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@PAMulligan PAMulligan self-assigned this May 28, 2026
@PAMulligan PAMulligan added documentation Improvements or additions to documentation security Security vulnerability code quality Code quality improvements labels May 28, 2026
@PAMulligan PAMulligan moved this from Todo to In Progress in PMDS Open Source Roadmap May 28, 2026
@PAMulligan PAMulligan moved this from In Progress to Done in PMDS Open Source Roadmap May 28, 2026
@PAMulligan PAMulligan added this to the v2.0.0 milestone May 28, 2026
@PAMulligan PAMulligan merged commit 9fc4b6a into main May 28, 2026
4 checks passed
@PAMulligan PAMulligan deleted the chore/versioning-audit-flavian branch May 28, 2026 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code quality Code quality improvements documentation Improvements or additions to documentation security Security vulnerability

Projects

Development

Successfully merging this pull request may close these issues.

1 participant