fix(3496): include all version patterns in changelog extraction (#90)
* fix(3496): include all version patterns in changelog extraction parseChangelog now handles multi-line bullets (continuation lines starting with two or more spaces) where the (#NNNN) PR trailer appears on a continuation line, not the opening dash line. The previous single-line regex silently dropped every such bullet, causing Feature/Enhancement sections to return 0 entries. Also adds an `extract` subcommand to scripts/changeset/cli.cjs: changeset/cli.cjs extract --from VERSION --to VERSION [--changelog FILE] [--json] Extracts releases strictly after --from (exclusive) and up to and including --to (inclusive). Accepts v-prefixed versions. Exits 2 when no releases fall in range, giving /gsd:update a deterministic range-aware helper instead of vague/manual extraction. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * test(3496): use production parseChangelog in markdown-mode assertion Replace raw stdout.includes() in the emits-markdown test with a parseChangelog call on the output so the assertion targets version strings via the production parser rather than a raw substring match. Eliminates the output-grep anti-pattern flagged by test-rigor. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore(changeset): add fragment for fix #3796 (issue #3496) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix(3496): reject malformed --from/--to semver in extract with structured error `parseSemver` coerced non-numeric components to 0 (e.g. `1.41.x` → `1.41.0`), making range selection silently wrong under typos or version-shape drift. Add a strict N.N.N validation gate before comparison; exit 1 with a JSON error report when either bound fails. Add two regression tests covering alphabetic and dotted-letter inputs. Codex adversarial review finding: high severity (scripts/changeset/cli.cjs:226-244) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix(3496): preserve bullets without PR trailer in parseChangelog (pr: null) Previously flushBullet() silently discarded any bullet that lacked a trailing (# NNNN) token. On the real CHANGELOG.md this dropped 7 entries from v1.41.0 alone, so cmdExtract returned incomplete release notes to the /gsd:update confirmation step. Store PR-less bullets as { body, pr: null } instead. Update cmdExtract's textOutput renderer to emit `- body` (no trailer) for null-pr bullets. Add regression tests: - serialize: preserves bullets without trailer as pr:null (not dropped) - cli extract: preserves PR-less and PR bullets together in extracted JSON - cli extract: rejects malformed --from/--to (1.41.x, foo) with exit 1 Codex adversarial review finding: high severity (scripts/changeset/serialize.cjs:64-73) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix(3496): wire extract into update.md + reject pre-release in range, fix CHANGELOG parser edge cases BLOCKER fixes: - F1: workflows/update.md show_changes_and_confirm step now invokes `scripts/changeset/cli.cjs extract --from $INSTALLED_VERSION --to $LATEST_VERSION --changelog $CHANGELOG_TMP --json` with explicit exit-2 handling ("no releases in range") and fallback text. The prior prose ("extract entries between versions") was never wired to the binary and silently skipped intermediate versions (#3496). - F2: releases.filter in cmdExtract now rejects any rel.version that does not pass SEMVER_RE before numeric-tuple comparison. parseSemver('1.0.0-rc.1') previously returned [1,0,0] (same as '1.0.0'), causing pre-release entries to corrupt range queries. Architectural choice: skip pre-release + 4-part versions with a stderr warning; full semver §11 pre-release ordering deferred to a consolidation issue (see F8 note below). MAJOR fixes: - F3 (serialize.cjs): releaseMatch regex updated to /^##\s+\[([^\]]+)\](?:\([^)]*\))?\s*(?:-\s*(\S+))?/ so linked-header format `## [1.42.1](url) - 2026-05-15` captures the date correctly. - F4 (serialize.cjs): continuation-line test now checks `!/^\s+-\s/` so ` - nested item` terminates the current bullet instead of folding in. - F5 (cli.cjs): 4-part versions (e.g. 1.0.0.1) fail SEMVER_RE and are skipped by the same guard added for F2. No separate code path needed. - F6 (serialize.cjs): v-prefix stripped from in-file version capture; `## [v1.0.0]` now parses as version "1.0.0". - F7 (serialize.cjs): continuation-line indentation relaxed from /^[ \t]{2}/ to /^\s+/ so 1-space-indented continuations fold correctly (F4's bullet-terminator guard prevents nested bullets from being folded). MINOR fixes: - F9 (cli.cjs): unknown-command path now exits 1 instead of 2 (exit 2 is reserved for "no releases in range" semantic). - F10 (cli.cjs): text-mode exit-2 path now writes "no releases found in range (from=X, to=Y)" to stderr. - F11 (tests): exit-2 test now asserts r.json is present and r.json.releases.length === 0. NOTE — F8 (semver consolidation): this codebase has 5+ distinct semver comparators with divergent pre-release policies; this PR adds a 6th (the SEMVER_RE guard in cmdExtract). A follow-up consolidation issue should be filed to unify all call sites. Out of scope for this PR. Regression tests added for F1–F6: pre-release exclusion, linked-header date parsing, nested-bullet termination, 4-part/v-prefix edge cases, and workflow wiring. All 15 tests pass. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix(lint): add allow-test-rule annotation to F1 workflow wiring test The F1 test reads get-shit-done/workflows/update.md (a product markdown file, not CJS source) to assert the extract subcommand invocation was wired. The lint-no-source-grep detector flags any readFileSync-bound variable used with .includes() regardless of file extension; annotate with // allow-test-rule to exempt this legitimate product-content assertion. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * test: apply deterministic barrier to locking-bugs #1927 config-set test The 'both concurrent config-set calls persist their values' test used Promise.all([execAsync(A), execAsync(B)]) without a barrier, which is non-deterministic under Docker load: one subprocess can complete before the other starts (no real contention) or both can race O_EXCL and observe stale fs state (lost write / assertion failure). Mirrors the locking-bugs:180 and :235 redesigns: erect a barrier file, spawn both subprocesses, wait for both to signal readiness via ready files, then drop the barrier simultaneously so both config-set calls genuinely contend on withPlanningLock. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Tom Boucher
@@ -19,7 +19,7 @@ const path = require('node:path');
|
||||
|
||||
const { parseFragment, FRAGMENT_ERROR } = require('./parse.cjs');
|
||||
const { renderChangelog } = require('./render.cjs');
|
||||
const { serializeChangelog } = require('./serialize.cjs');
|
||||
const { serializeChangelog, parseChangelog } = require('./serialize.cjs');
|
||||
const { renderGithubReleaseNotes } = require('./github-release-notes.cjs');
|
||||
|
||||
function parseArgs(argv) {
|
||||
@@ -30,6 +30,7 @@ function parseArgs(argv) {
|
||||
date: null,
|
||||
fromRef: null,
|
||||
toRef: null,
|
||||
changelog: null,
|
||||
output: null,
|
||||
repoSlug: 'GSD-redux/get-shit-done-redux',
|
||||
installCommand: 'npx get-shit-done-redux@latest',
|
||||
@@ -59,6 +60,7 @@ function parseArgs(argv) {
|
||||
a === '--date' ||
|
||||
a === '--from' ||
|
||||
a === '--to' ||
|
||||
a === '--changelog' ||
|
||||
a === '--output' ||
|
||||
a === '--repo-slug' ||
|
||||
a === '--install-command'
|
||||
@@ -70,6 +72,7 @@ function parseArgs(argv) {
|
||||
else if (a === '--date') opts.date = r.value;
|
||||
else if (a === '--from') opts.fromRef = r.value;
|
||||
else if (a === '--to') opts.toRef = r.value;
|
||||
else if (a === '--changelog') opts.changelog = r.value;
|
||||
else if (a === '--output') opts.output = r.value;
|
||||
else if (a === '--repo-slug') opts.repoSlug = r.value;
|
||||
else if (a === '--install-command') opts.installCommand = r.value;
|
||||
@@ -180,6 +183,121 @@ function cmdRender(opts) {
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* extract subcommand: extracts all changelog release blocks strictly after
|
||||
* `--from` (exclusive) up to and including `--to` (inclusive). Both
|
||||
* arguments accept `v`-prefixed semver (e.g. `v1.5.13`).
|
||||
*
|
||||
* Exit codes:
|
||||
* 0 — one or more releases matched, output written.
|
||||
* 2 — no releases fall in the specified range (matches nothing).
|
||||
* 1 — I/O error or missing required flags.
|
||||
*
|
||||
* Fix for #3496: provides a deterministic range-aware helper so the
|
||||
* `/gsd:update` show_changes_and_confirm step no longer relies on
|
||||
* vague/manual extraction that can silently skip intermediate versions.
|
||||
*/
|
||||
function cmdExtract(opts) {
|
||||
const stripV = (v) => (typeof v === 'string' ? v.replace(/^v/, '') : v);
|
||||
const from = stripV(opts.fromRef);
|
||||
const to = stripV(opts.toRef);
|
||||
|
||||
// Validate that both bounds are strict semver (N.N.N, digits only).
|
||||
// Coercing a malformed bound like "1.41.x" to "1.41.0" makes range
|
||||
// selection silently wrong; reject early with a structured error.
|
||||
const SEMVER_RE = /^\d+\.\d+\.\d+$/;
|
||||
if (!SEMVER_RE.test(from)) {
|
||||
return {
|
||||
exitCode: 1,
|
||||
report: { error: `invalid semver for --from: "${from}" (expected N.N.N)`, releases: [] },
|
||||
textOutput: null,
|
||||
};
|
||||
}
|
||||
if (!SEMVER_RE.test(to)) {
|
||||
return {
|
||||
exitCode: 1,
|
||||
report: { error: `invalid semver for --to: "${to}" (expected N.N.N)`, releases: [] },
|
||||
textOutput: null,
|
||||
};
|
||||
}
|
||||
|
||||
const changelogPath = opts.changelog
|
||||
? path.resolve(opts.changelog)
|
||||
: path.join(path.resolve(opts.repo), 'CHANGELOG.md');
|
||||
|
||||
if (!fs.existsSync(changelogPath)) {
|
||||
return {
|
||||
exitCode: 1,
|
||||
report: { error: `CHANGELOG not found: ${changelogPath}`, releases: [] },
|
||||
textOutput: null,
|
||||
};
|
||||
}
|
||||
|
||||
const text = fs.readFileSync(changelogPath, 'utf8');
|
||||
const { releases } = parseChangelog(text);
|
||||
|
||||
// Walk the releases in document order (newest-first in a standard
|
||||
// Keep-a-Changelog file). Collect every release whose version is
|
||||
// strictly after `from` and up to and including `to`.
|
||||
//
|
||||
// The comparison is semver-aware via the standard numeric-tuple approach
|
||||
// so that "1.5.9" < "1.5.10" (string comparison would fail here).
|
||||
function parseSemver(v) {
|
||||
const parts = String(v).split('.').map(Number);
|
||||
return [parts[0] || 0, parts[1] || 0, parts[2] || 0];
|
||||
}
|
||||
|
||||
function semverCmp(a, b) {
|
||||
const [a0, a1, a2] = parseSemver(a);
|
||||
const [b0, b1, b2] = parseSemver(b);
|
||||
return a0 !== b0 ? a0 - b0 : a1 !== b1 ? a1 - b1 : a2 - b2;
|
||||
}
|
||||
|
||||
const matched = releases.filter((rel) => {
|
||||
if (rel.version === 'Unreleased') return false;
|
||||
// Skip pre-release entries (e.g. 1.0.0-rc.1, 1.0.0-beta.2) — they cannot
|
||||
// be range-compared via numeric tuples without implementing full pre-release
|
||||
// ordering (semver §11). Exclude them silently for now; a consolidation
|
||||
// issue (#F8) will address pre-release ordering across all comparators.
|
||||
if (!SEMVER_RE.test(rel.version)) {
|
||||
process.stderr.write(`[extract] skipping pre-release/non-semver entry: ${rel.version}\n`);
|
||||
return false;
|
||||
}
|
||||
// from is exclusive: cmp > 0 means rel.version > from
|
||||
const afterFrom = semverCmp(rel.version, from) > 0;
|
||||
// to is inclusive: cmp <= 0 means rel.version <= to
|
||||
const upToTo = semverCmp(rel.version, to) <= 0;
|
||||
return afterFrom && upToTo;
|
||||
});
|
||||
|
||||
if (matched.length === 0) {
|
||||
return {
|
||||
exitCode: 2,
|
||||
report: { releases: [], from, to },
|
||||
textOutput: null,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
exitCode: 0,
|
||||
report: { releases: matched, from, to },
|
||||
textOutput: matched
|
||||
.map((rel) => {
|
||||
const header = `## [${rel.version}]${rel.date ? ` - ${rel.date}` : ''}`;
|
||||
const sections = (rel.sections || [])
|
||||
.map((s) => {
|
||||
const bullets = s.bullets
|
||||
.map((b) => (b.pr !== null ? `- ${b.body} (#${b.pr})` : `- ${b.body}`))
|
||||
.join('\n');
|
||||
return `### ${s.type}\n\n${bullets}`;
|
||||
})
|
||||
.join('\n\n');
|
||||
return sections ? `${header}\n\n${sections}` : header;
|
||||
})
|
||||
.join('\n\n'),
|
||||
};
|
||||
}
|
||||
|
||||
function cmdGithubReleaseNotes(opts) {
|
||||
const repo = path.resolve(opts.repo);
|
||||
const report = renderGithubReleaseNotes({
|
||||
@@ -222,6 +340,10 @@ function usage() {
|
||||
'usage:',
|
||||
' changeset/cli.cjs render --repo <dir> --version V --date D [--json]',
|
||||
' changeset/cli.cjs github-release-notes --repo <dir> --from REF --to REF [--output FILE] [--repo-slug OWNER/REPO] [--install-command CMD] [--json]',
|
||||
' changeset/cli.cjs extract --from VERSION --to VERSION [--changelog FILE] [--repo <dir>] [--json]',
|
||||
' Extracts changelog entries strictly after --from (exclusive) and up to',
|
||||
' and including --to (inclusive). Accepts v-prefixed versions.',
|
||||
' Exit 2 when no releases fall in range.',
|
||||
'',
|
||||
].join('\n');
|
||||
}
|
||||
@@ -234,9 +356,9 @@ function main() {
|
||||
process.exit(2);
|
||||
}
|
||||
const { opts } = parsed;
|
||||
if (opts.cmd !== 'render' && opts.cmd !== 'github-release-notes') {
|
||||
if (opts.cmd !== 'render' && opts.cmd !== 'github-release-notes' && opts.cmd !== 'extract') {
|
||||
process.stderr.write(usage());
|
||||
process.exit(2);
|
||||
process.exit(1);
|
||||
}
|
||||
if (opts.cmd === 'render' && (!opts.version || !opts.date)) {
|
||||
process.stderr.write('--version and --date are required for render\n');
|
||||
@@ -246,6 +368,23 @@ function main() {
|
||||
process.stderr.write('--from and --to are required for github-release-notes\n');
|
||||
process.exit(2);
|
||||
}
|
||||
if (opts.cmd === 'extract' && (!opts.fromRef || !opts.toRef)) {
|
||||
process.stderr.write('--from and --to are required for extract\n');
|
||||
process.stderr.write(usage());
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (opts.cmd === 'extract') {
|
||||
const { exitCode, report, textOutput } = cmdExtract(opts);
|
||||
if (opts.json) {
|
||||
process.stdout.write(JSON.stringify(report, null, 2) + '\n');
|
||||
} else if (textOutput) {
|
||||
process.stdout.write(textOutput + '\n');
|
||||
} else if (exitCode === 2) {
|
||||
process.stderr.write(`no releases found in range (from=${report.from}, to=${report.to})\n`);
|
||||
}
|
||||
process.exit(exitCode);
|
||||
}
|
||||
|
||||
const { exitCode, report } = opts.cmd === 'render' ? cmdRender(opts) : cmdGithubReleaseNotes(opts);
|
||||
if (opts.json) {
|
||||
@@ -266,4 +405,4 @@ function main() {
|
||||
|
||||
if (require.main === module) main();
|
||||
|
||||
module.exports = { cmdRender, cmdGithubReleaseNotes, parseArgs, splitChangelog, listFragmentFiles, usage };
|
||||
module.exports = { cmdRender, cmdExtract, cmdGithubReleaseNotes, parseArgs, splitChangelog, listFragmentFiles, usage };
|
||||
|
||||
@@ -41,16 +41,54 @@ function serializeChangelog(ir) {
|
||||
* Inverse parser: extracts the structured releases from a CHANGELOG.md
|
||||
* text. Returns { releases: [{ version, date, sections: [{ type, bullets:
|
||||
* [{ pr, body }] }] }] }. Tolerates the actual repo's CHANGELOG dialect.
|
||||
*
|
||||
* Multi-line bullets are supported: a bullet opens on a line starting with
|
||||
* `- ` and continues on lines starting with two or more spaces (or a tab).
|
||||
* The `(#NNNN)` PR trailer may appear on any continuation line. Single-line
|
||||
* bullets (entire entry on one `- ` line) are still handled as before.
|
||||
*
|
||||
* Fix for #3496: the previous implementation only matched single-line bullets
|
||||
* whose `(#NNNN)` suffix was on the same line as the opening `- `. Long
|
||||
* bullets — which wrap onto indented continuation lines — returned 0 entries
|
||||
* for their section even when the markdown was well-formed.
|
||||
*/
|
||||
function parseChangelog(text) {
|
||||
const releases = [];
|
||||
const lines = text.split(/\r?\n/);
|
||||
let cur = null;
|
||||
let curSection = null;
|
||||
// Accumulates lines belonging to the current in-flight bullet (may span
|
||||
// multiple lines). Flushed when a new block-level element is encountered.
|
||||
let bulletLines = null;
|
||||
|
||||
function flushBullet() {
|
||||
if (bulletLines === null || !curSection) return;
|
||||
const joined = bulletLines.join(' ').trim();
|
||||
// Locate the (# pr) trailer anywhere in the joined text. The trailer is
|
||||
// expected to be at the very end, but we tolerate trailing whitespace.
|
||||
const trailMatch = joined.match(/^(.*?)\s*\(#(\d+)\)\s*$/);
|
||||
if (trailMatch) {
|
||||
curSection.bullets.push({ body: trailMatch[1].trim(), pr: Number(trailMatch[2]) });
|
||||
} else {
|
||||
// Bullet has no PR trailer — preserve it with pr: null so callers
|
||||
// (e.g. cmdExtract) do not silently drop authored content.
|
||||
curSection.bullets.push({ body: joined, pr: null });
|
||||
}
|
||||
bulletLines = null;
|
||||
}
|
||||
|
||||
for (const line of lines) {
|
||||
const releaseMatch = line.match(/^##\s+\[([^\]]+)\](?:\s*-\s*(\S+))?/);
|
||||
// F3: match linked headers: ## [1.42.1](url) - 2026-05-15
|
||||
// The (?:\([^)]*\))? group skips an optional (url) after the closing ]
|
||||
// before looking for the optional date suffix.
|
||||
// F6: strip a leading `v` from the captured version so `## [v1.0.0]`
|
||||
// parses as version "1.0.0" instead of "v1.0.0".
|
||||
const releaseMatch = line.match(/^##\s+\[([^\]]+)\](?:\([^)]*\))?\s*(?:-\s*(\S+))?/);
|
||||
if (releaseMatch) {
|
||||
cur = { version: releaseMatch[1], date: releaseMatch[2] || null, sections: [] };
|
||||
flushBullet();
|
||||
const rawVersion = releaseMatch[1];
|
||||
const version = rawVersion.replace(/^v/, '');
|
||||
cur = { version, date: releaseMatch[2] || null, sections: [] };
|
||||
curSection = null;
|
||||
releases.push(cur);
|
||||
continue;
|
||||
@@ -58,16 +96,34 @@ function parseChangelog(text) {
|
||||
if (!cur) continue;
|
||||
const sectionMatch = line.match(/^###\s+(.+?)\s*$/);
|
||||
if (sectionMatch) {
|
||||
flushBullet();
|
||||
curSection = { type: sectionMatch[1], bullets: [] };
|
||||
cur.sections.push(curSection);
|
||||
continue;
|
||||
}
|
||||
if (!curSection) continue;
|
||||
const bulletMatch = line.match(/^-\s+(.*?)\s*\(#(\d+)\)\s*$/);
|
||||
if (bulletMatch) {
|
||||
curSection.bullets.push({ body: bulletMatch[1], pr: Number(bulletMatch[2]) });
|
||||
|
||||
// New bullet: line begins with `- ` (after optional leading spaces that
|
||||
// would indicate a nested list — we only handle top-level bullets here).
|
||||
if (/^-\s+/.test(line)) {
|
||||
flushBullet();
|
||||
bulletLines = [line.replace(/^-\s+/, '')];
|
||||
continue;
|
||||
}
|
||||
|
||||
// Continuation line: any indentation (F7: relaxed from /^[ \t]{2}/ so that
|
||||
// 1-space-indented continuations also fold) BUT NOT a nested bullet marker
|
||||
// (F4: ` - nested item` terminates the current bullet rather than folding).
|
||||
if (bulletLines !== null && /^\s+/.test(line) && !/^\s+-\s/.test(line)) {
|
||||
bulletLines.push(line.trim());
|
||||
continue;
|
||||
}
|
||||
|
||||
// Any other line (blank, heading, nested bullet, etc.) terminates a pending bullet.
|
||||
flushBullet();
|
||||
}
|
||||
flushBullet();
|
||||
|
||||
return { releases };
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user