Skip to content

docs(changelog): move premature 1.0.0 entry out of release history#297

Open
khuepm wants to merge 1 commit into
mainfrom
fix/changelog-premature-100
Open

docs(changelog): move premature 1.0.0 entry out of release history#297
khuepm wants to merge 1 commit into
mainfrom
fix/changelog-premature-100

Conversation

@khuepm

@khuepm khuepm commented Jul 25, 2026

Copy link
Copy Markdown
Owner

Closes part of §5 in the v1.0.0 readiness checklist.

Vấn đề

CHANGELOG.md có section ## [1.0.0] - 2026-07-11 nằm kẹp giữa [0.22.0][0.21.0]. 1.0.0 chưa bao giờ được tag, nên file đang khẳng định một bản release không tồn tại — và đặt nó trước 0.22.0, 0.23.0, 0.24.x là những bản có thật.

Nghiêm trọng hơn, nó sẽ làm vỡ lần release thật kế tiếp: /release step 2 chèn section mới ngay dưới ## [Unreleased], nên khi cắt 1.0.0 sẽ có hai heading ## [1.0.0], và đoạn awk extract ở cùng step đó dừng ở match đầu tiên → GitHub Release sẽ lấy đúng bản text stale.

Thay đổi

  • Bỏ section [1.0.0] khỏi lịch sử release trong CHANGELOG.md (-77 dòng).
  • Giữ nguyên văn phần prose trong .kiro/steering/v1-changelog-draft.md, cạnh các doc v1 khác (v1-release-criteria.md, v1-scope-classification.md), kèm ghi chú những chỗ đã stale để lần viết lại ở RC không bắt đầu từ số 0:
    • dừng ở 0.21.x, chưa cover 0.22.0 → 0.24.1 (MCP server, NVIDIA/Vertex, pageviews, extension signing, OWASP audit…)
    • vẫn ghi CWE-521 là "required v1 fix" trong khi đã fix; bảng audit nay 78 ✅ / 0 ⚠️ / 0 ❌
    • mô tả RBAC backfill là "verified" từ thời điểm repo chưa có gì chứng minh — nay đã có backfill/role-policies.ts + CLI + upgrade-path.e2e.test.ts trong CI

Docs-only, không đụng code.

Kiểm chứng sau khi sửa

  • Heading version giảm dần đúng semver, không còn heading trùng
  • Chỗ nối [0.20.0][0.21.0] nguyên vẹn, không thừa/thiếu dòng trắng
  • Không có chỗ nào link tới anchor CHANGELOG.md#1...
  • awk extractor của /release vẫn trả về đúng section cho 0.24.1

CHANGELOG.md carried a `## [1.0.0] - 2026-07-11` section wedged between
[0.22.0] and [0.21.0]. 1.0.0 has never been tagged, so the file asserted
a release that does not exist — and placed it before 0.22.0, 0.23.0 and
0.24.x, which do.

It would also have broken the next real release. `/release` step 2
inserts the new section directly under `## [Unreleased]`, so cutting
1.0.0 would have produced two `## [1.0.0]` headings, and the awk
extractor in that same step stops at the first match — the GitHub
Release would have shipped the stale text.

The prose is preserved in `.kiro/steering/v1-changelog-draft.md`
alongside the other v1 release docs, with the staleness recorded so the
RC-time rewrite starts from a known state rather than from scratch: it
stops at 0.21.x (no 0.22 → 0.24.1 coverage), still lists CWE-521 as an
open v1 fix, and describes the RBAC backfill as "verified" from a time
when the repo had nothing to back that up.

Verified after the edit: version headings are strictly descending by
semver, no duplicate heading, the [0.20.0] → [0.21.0] join is intact,
nothing links to a `CHANGELOG.md#1...` anchor, and the /release awk
extractor still returns the right section for 0.24.1.
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