The rc action publishes a release candidate to @next for testing but never surfaces the curated CHANGELOG section for the version under test — render only runs destructively at finalize (#715), so there was no safe way to preview the upcoming notes during the RC window. Add a --preview mode to scripts/changeset/cli.cjs cmdRender: it renders the dated release section to stdout via the existing renderChangelog/ serializeChangelog path (with priorChangelog: null, so only the new section is emitted), reuses the shared injectEmptyPlaceholder helper for zero-fragment releases, and returns WITHOUT writing CHANGELOG.md or deleting any .changeset fragment. Wire a "Preview CHANGELOG" step into the rc job that renders to a file (standalone command, so a malformed fragment fails the step) and cats it to the job summary and log. Closes #759 Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
'use strict';
|
||||
process.env.GSD_TEST_MODE = '1';
|
||||
|
||||
const { test, describe, before, after } = require('node:test');
|
||||
const { test, describe, before, after, beforeEach } = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
const fs = require('node:fs');
|
||||
const os = require('node:os');
|
||||
@@ -36,6 +36,11 @@ function runRender(args = []) {
|
||||
};
|
||||
}
|
||||
|
||||
function runRenderRaw(args = []) {
|
||||
const r = cp.spawnSync(process.execPath, [SCRIPT, 'render', '--repo', tmp, ...args], { encoding: 'utf8' });
|
||||
return { status: r.status, stdout: r.stdout || '', stderr: r.stderr || '' };
|
||||
}
|
||||
|
||||
before(() => { tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-changeset-')); });
|
||||
after(() => { cleanup(tmp); });
|
||||
|
||||
@@ -928,3 +933,107 @@ describe('changeset cli render --allow-empty', () => {
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// GROUP D — render --preview (#759)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe('changeset cli render --preview (#759)', () => {
|
||||
// Helper: reset the shared tmp dir to a clean state for preview tests.
|
||||
function resetTmp() {
|
||||
// Remove CHANGELOG.md if present.
|
||||
const changelogPath = path.join(tmp, 'CHANGELOG.md');
|
||||
if (fs.existsSync(changelogPath)) {
|
||||
fs.unlinkSync(changelogPath);
|
||||
}
|
||||
// Remove any leftover .changeset/*.md fragments.
|
||||
const changesetDir = path.join(tmp, '.changeset');
|
||||
if (fs.existsSync(changesetDir)) {
|
||||
for (const f of fs.readdirSync(changesetDir)) {
|
||||
if (f.endsWith('.md') && f !== 'README.md') {
|
||||
fs.unlinkSync(path.join(changesetDir, f));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Reset state before each preview test so a new test added to this group
|
||||
// can never inherit a CHANGELOG.md or fragments left by the previous one.
|
||||
beforeEach(resetTmp);
|
||||
|
||||
test('render --preview prints the section to stdout and mutates nothing', () => {
|
||||
writeFragment('preview-frag-one', 'Added', 900, 'preview-added-feature');
|
||||
|
||||
const fragmentPath = path.join(tmp, '.changeset', 'preview-frag-one.md');
|
||||
const r = runRenderRaw(['--version', '9.9.0', '--date', '2026-01-02', '--preview']);
|
||||
|
||||
assert.equal(r.status, 0, `expected exit 0; stderr=${r.stderr}`);
|
||||
assert.ok(r.stdout.includes('## [9.9.0]'), `stdout must contain ## [9.9.0]; got: ${r.stdout}`);
|
||||
assert.ok(r.stdout.includes('### Added'), `stdout must contain ### Added; got: ${r.stdout}`);
|
||||
assert.ok(r.stdout.includes('preview-added-feature'), `stdout must contain fragment body; got: ${r.stdout}`);
|
||||
|
||||
// CHANGELOG.md must NOT have been created.
|
||||
assert.ok(!fs.existsSync(path.join(tmp, 'CHANGELOG.md')), 'CHANGELOG.md must NOT be created by --preview');
|
||||
|
||||
// Fragment file must still exist.
|
||||
assert.ok(fs.existsSync(fragmentPath), 'fragment file must still exist after --preview');
|
||||
});
|
||||
|
||||
test('render --preview with zero fragments emits the placeholder and writes nothing', () => {
|
||||
// No fragments written — zero-fragment scenario.
|
||||
|
||||
const r = runRenderRaw(['--version', '9.9.0', '--date', '2026-01-02', '--preview']);
|
||||
|
||||
assert.equal(r.status, 0, `expected exit 0; stderr=${r.stderr}`);
|
||||
assert.ok(r.stdout.includes('## ['), `stdout must contain a release heading; got: ${r.stdout}`);
|
||||
assert.ok(r.stdout.includes('_No notable changes._'), `stdout must contain placeholder; got: ${r.stdout}`);
|
||||
|
||||
// CHANGELOG.md must NOT have been created.
|
||||
assert.ok(!fs.existsSync(path.join(tmp, 'CHANGELOG.md')), 'CHANGELOG.md must NOT be created by zero-fragment --preview');
|
||||
});
|
||||
|
||||
test('render --preview --json returns preview text in report with consumed 0', () => {
|
||||
writeFragment('preview-frag-two', 'Fixed', 901, 'preview-fixed-bug');
|
||||
|
||||
const fragmentPath = path.join(tmp, '.changeset', 'preview-frag-two.md');
|
||||
// runRender appends --json automatically.
|
||||
const r = runRender(['--version', '9.9.0', '--date', '2026-01-02', '--preview']);
|
||||
|
||||
assert.equal(r.status, 0, `expected exit 0; stderr=${r.stderr}`);
|
||||
assert.ok(r.report, 'report must be parseable JSON');
|
||||
assert.strictEqual(r.report.consumed, 0, 'consumed must be 0 for preview');
|
||||
assert.strictEqual(r.report.fragmentCount, 1, 'fragmentCount must be 1');
|
||||
assert.ok(typeof r.report.preview === 'string', 'report.preview must be a string');
|
||||
assert.ok(r.report.preview.includes('## [9.9.0]'), `report.preview must contain ## [9.9.0]; got: ${r.report.preview}`);
|
||||
|
||||
// Fragment file must still exist.
|
||||
assert.ok(fs.existsSync(fragmentPath), 'fragment file must still exist after --preview --json');
|
||||
});
|
||||
|
||||
test('render --preview with an existing CHANGELOG.md leaves it byte-identical and shows only the new section', () => {
|
||||
// Seed an existing CHANGELOG with a prior dated release.
|
||||
const changelogPath = path.join(tmp, 'CHANGELOG.md');
|
||||
const existing =
|
||||
'# Changelog\n\n## [1.0.0] - 2020-01-01\n\n### Added\n\n- old prior feature (#1)\n';
|
||||
fs.writeFileSync(changelogPath, existing);
|
||||
writeFragment('preview-frag-three', 'Added', 902, 'brand-new-thing');
|
||||
const before = fs.readFileSync(changelogPath, 'utf8');
|
||||
|
||||
const r = runRenderRaw(['--version', '9.9.0', '--date', '2026-01-02', '--preview']);
|
||||
|
||||
assert.equal(r.status, 0, `expected exit 0; stderr=${r.stderr}`);
|
||||
// Output shows the new section...
|
||||
assert.ok(r.stdout.includes('## [9.9.0]'), `stdout must contain new heading; got: ${r.stdout}`);
|
||||
assert.ok(r.stdout.includes('brand-new-thing'), `stdout must contain new fragment body; got: ${r.stdout}`);
|
||||
// ...and NOT the prior release history (preview is the new section only).
|
||||
assert.ok(!r.stdout.includes('## [1.0.0]'), `preview must NOT include prior releases; got: ${r.stdout}`);
|
||||
assert.ok(!r.stdout.includes('old prior feature'), `preview must NOT include prior bullets; got: ${r.stdout}`);
|
||||
|
||||
// Existing CHANGELOG.md must be byte-identical — preview mutates nothing.
|
||||
assert.strictEqual(
|
||||
fs.readFileSync(changelogPath, 'utf8'),
|
||||
before,
|
||||
'CHANGELOG.md must be byte-identical after --preview',
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user