Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

fix(release): preserve post-cut manifest fields (#7159)

Cindy Zhang9a35bb574b70
diff --git a/scripts/release/active-release.mjs b/scripts/release/active-release.mjs
index 0c8c566b8e..599e4583a3 100644
--- a/scripts/release/active-release.mjs
+++ b/scripts/release/active-release.mjs
@@ -256,23 +256,46 @@ function changesetMapAtRef(root, ref) {
);
}
+function isPackageManifestPath(file) {
+ return /^packages\/(?:[^/]+|themes\/[^/]+)\/package\.json$/.test(file);
+}
+
+function releaseOutputPathsAtRef(root, plan, releaseRef) {
+ return git(root, ['diff', '--name-only', plan.cutSha, releaseRef, '--'])
+ .split('\n')
+ .filter(Boolean);
+}
+
function releaseOutputMapAtRef(root, plan, releaseRef) {
- const files = git(root, [
- 'diff',
- '--name-only',
- plan.cutSha,
- releaseRef,
- '--',
- ]);
return new Map(
- files
- .split('\n')
- .filter(Boolean)
+ releaseOutputPathsAtRef(root, plan, releaseRef)
.filter(isReleaseOutputPath)
+ .filter(file => !isPackageManifestPath(file) && file !== 'pnpm-lock.yaml')
.map(file => [file, fileDigestAtRef(root, releaseRef, file)]),
);
}
+function jsonAtRef(root, ref, file) {
+ try {
+ return JSON.parse(git(root, ['show', `${ref}:${file}`]));
+ } catch {
+ return null;
+ }
+}
+
+function manifestMapAtRef(root, ref, files) {
+ return new Map([...files].map(file => [file, jsonAtRef(root, ref, file)]));
+}
+
+function currentManifestMap(root, files) {
+ return new Map(
+ [...files].map(file => {
+ const absolute = path.join(root, file);
+ return [file, fs.existsSync(absolute) ? readJson(absolute) : null];
+ }),
+ );
+}
+
function currentOutputMap(root, files) {
return new Map(
[...files].map(file => {
@@ -394,6 +417,57 @@ function validateReleaseDiff(entries, {plan, baseChangesets} = {}) {
return errors;
}
+const VERSION_DEPENDENCY_FIELDS = [
+ 'dependencies',
+ 'devDependencies',
+ 'optionalDependencies',
+ 'peerDependencies',
+];
+
+function expectedSyncedManifest({file, cut, base, release}) {
+ if (!cut || !base || !release)
+ return {error: `release sync cannot read manifest history: ${file}`};
+
+ const releaseFromCut = structuredClone(cut);
+ releaseFromCut.version = release.version;
+ const expected = structuredClone(base);
+ expected.version = release.version;
+
+ for (const field of VERSION_DEPENDENCY_FIELDS) {
+ const cutValues = cut[field] ?? {};
+ const releaseValues = release[field] ?? {};
+ const names = new Set([
+ ...Object.keys(cutValues),
+ ...Object.keys(releaseValues),
+ ]);
+ for (const name of names) {
+ if (canonicalJson(cutValues[name]) === canonicalJson(releaseValues[name]))
+ continue;
+ if (!name.startsWith('@astryxdesign/'))
+ return {
+ error: `published manifest contains a non-version release change: ${file} ${field}.${name}`,
+ };
+ releaseFromCut[field] ??= {};
+ if (releaseValues[name] === undefined) delete releaseFromCut[field][name];
+ else releaseFromCut[field][name] = releaseValues[name];
+
+ if (
+ canonicalJson(base[field]?.[name]) === canonicalJson(cutValues[name])
+ ) {
+ expected[field] ??= {};
+ if (releaseValues[name] === undefined) delete expected[field][name];
+ else expected[field][name] = releaseValues[name];
+ }
+ }
+ }
+
+ if (canonicalJson(releaseFromCut) !== canonicalJson(release))
+ return {
+ error: `published manifest contains a non-version release change: ${file}`,
+ };
+ return {expected};
+}
+
function validateReleaseSync({
entries,
plan,
@@ -401,6 +475,10 @@ function validateReleaseSync({
headChangesets,
releaseOutputs,
headOutputs,
+ cutManifests = new Map(),
+ baseManifests = new Map(),
+ releaseManifests = new Map(),
+ headManifests = new Map(),
}) {
const errors = [];
const planned = new Set(plan.changesets.map(entry => entry.path));
@@ -414,6 +492,11 @@ function validateReleaseSync({
if (file.startsWith('.changeset/')) {
if (status !== 'D' || !planned.has(file))
errors.push(`release sync may only delete frozen Changesets: ${file}`);
+ } else if (isPackageManifestPath(file)) {
+ if (!releaseManifests.has(file))
+ errors.push(
+ `release sync changed an unplanned package manifest: ${file}`,
+ );
} else if (
!isReleaseOutputPath(file) &&
!/^\.github\/pages\/assets\/(?:manifest\.json|reset\.css|astryx\.css|theme\.css)$/.test(
@@ -442,6 +525,23 @@ function validateReleaseSync({
if (headOutputs.get(file) !== digest)
errors.push(`release sync output differs from published branch: ${file}`);
}
+ for (const [file, release] of releaseManifests) {
+ const result = expectedSyncedManifest({
+ file,
+ cut: cutManifests.get(file),
+ base: baseManifests.get(file),
+ release,
+ });
+ if (result.error) {
+ errors.push(result.error);
+ continue;
+ }
+ const head = headManifests.get(file);
+ if (!head || head.version !== release.version)
+ errors.push(`release sync manifest has the wrong version: ${file}`);
+ if (canonicalJson(head) !== canonicalJson(result.expected))
+ errors.push(`release sync changed non-version manifest fields: ${file}`);
+ }
return errors;
}
@@ -498,7 +598,9 @@ function writeAuthority(root, values, refresh) {
if (refresh) {
if (!markerExists || !planExists)
- throw new Error('release refresh requires an existing active marker and plan');
+ throw new Error(
+ 'release refresh requires an existing active marker and plan',
+ );
const existingMarker = readJson(markerPath);
const existingPlan = readJson(planPath);
const identityErrors = validateIdentity(existingMarker, existingPlan);
@@ -605,6 +707,22 @@ function main() {
'HEAD',
]);
const releaseOutputs = releaseOutputMapAtRef(root, plan, releaseRef);
+ const releaseManifestFiles = releaseOutputPathsAtRef(
+ root,
+ plan,
+ releaseRef,
+ ).filter(isPackageManifestPath);
+ const cutManifests = manifestMapAtRef(
+ root,
+ plan.cutSha,
+ releaseManifestFiles,
+ );
+ const baseManifests = manifestMapAtRef(root, base, releaseManifestFiles);
+ const releaseManifests = manifestMapAtRef(
+ root,
+ releaseRef,
+ releaseManifestFiles,
+ );
errors.push(
...validateReleaseSync({
entries: raw ? raw.split('\n') : [],
@@ -615,6 +733,10 @@ function main() {
),
releaseOutputs,
headOutputs: currentOutputMap(root, releaseOutputs.keys()),
+ cutManifests,
+ baseManifests,
+ releaseManifests,
+ headManifests: currentManifestMap(root, releaseManifestFiles),
}),
);
if (errors.length) throw new Error(errors.join('\n'));
diff --git a/scripts/release/active-release.test.mjs b/scripts/release/active-release.test.mjs
index 3b194c6b99..e336215d3d 100644
--- a/scripts/release/active-release.test.mjs
+++ b/scripts/release/active-release.test.mjs
@@ -118,7 +118,10 @@ describe('one branch per release lifecycle', () => {
writeAuthority(root, values, false);
const markerPath = path.join(root, '.release/active.json');
const marker = JSON.parse(fs.readFileSync(markerPath, 'utf8'));
- fs.writeFileSync(markerPath, `${JSON.stringify({...marker, state: 'closed'})}\n`);
+ fs.writeFileSync(
+ markerPath,
+ `${JSON.stringify({...marker, state: 'closed'})}\n`,
+ );
expect(() => writeAuthority(root, values, true)).toThrow(
'marker state must be active',
@@ -350,6 +353,31 @@ describe('active release branch authority', () => {
describe('post-release bookkeeping sync', () => {
const digest = value => value.repeat(64).slice(0, 64);
+ const manifestPath = 'packages/core/package.json';
+ const cutManifest = {
+ name: '@astryxdesign/core',
+ version: '0.6.5',
+ exports: {'.': './dist/index.js'},
+ files: ['dist'],
+ sideEffects: false,
+ dependencies: {'@astryxdesign/build': '^0.6.5'},
+ };
+ const releaseManifest = {
+ ...cutManifest,
+ version: '0.6.6',
+ dependencies: {'@astryxdesign/build': '^0.6.6'},
+ };
+ const baseManifest = {
+ ...cutManifest,
+ exports: {...cutManifest.exports, './fonts.css': './dist/fonts.css'},
+ files: ['dist', 'fonts.css'],
+ sideEffects: ['*.css'],
+ };
+ const headManifest = {
+ ...baseManifest,
+ version: '0.6.6',
+ dependencies: {'@astryxdesign/build': '^0.6.6'},
+ };
const plan = {
changesets: [
{path: '.changeset/frozen.md', sha256: digest('a')},
@@ -361,7 +389,7 @@ describe('post-release bookkeeping sync', () => {
return validateReleaseSync({
entries: [
'D\t.changeset/frozen.md',
- 'M\tpackages/core/package.json',
+ `M\t${manifestPath}`,
'M\tpackages/core/CHANGELOG.md',
],
plan,
@@ -370,28 +398,47 @@ describe('post-release bookkeeping sync', () => {
['.changeset/post-cut.md', digest('c')],
]),
headChangesets: new Map([['.changeset/post-cut.md', digest('c')]]),
- releaseOutputs: new Map([
- ['packages/core/package.json', digest('d')],
- ['packages/core/CHANGELOG.md', digest('e')],
- ]),
- headOutputs: new Map([
- ['packages/core/package.json', digest('d')],
- ['packages/core/CHANGELOG.md', digest('e')],
- ]),
+ releaseOutputs: new Map([['packages/core/CHANGELOG.md', digest('e')]]),
+ headOutputs: new Map([['packages/core/CHANGELOG.md', digest('e')]]),
+ cutManifests: new Map([[manifestPath, cutManifest]]),
+ baseManifests: new Map([[manifestPath, baseManifest]]),
+ releaseManifests: new Map([[manifestPath, releaseManifest]]),
+ headManifests: new Map([[manifestPath, headManifest]]),
...overrides,
});
}
- it('accepts consumed-only deletion, exact outputs, and idempotent reruns', () => {
+ it('accepts version-only manifests, exact outputs, and idempotent reruns', () => {
expect(sync()).toEqual([]);
expect(
sync({
entries: [],
baseChangesets: new Map([['.changeset/post-cut.md', digest('c')]]),
+ baseManifests: new Map([[manifestPath, headManifest]]),
}),
).toEqual([]);
});
+ it('rejects wholesale release-manifest copies that erase newer main fields', () => {
+ expect(
+ sync({headManifests: new Map([[manifestPath, releaseManifest]])}),
+ ).toContain(
+ `release sync changed non-version manifest fields: ${manifestPath}`,
+ );
+ });
+
+ it('rejects any other non-version manifest change', () => {
+ expect(
+ sync({
+ headManifests: new Map([
+ [manifestPath, {...headManifest, scripts: {build: 'changed'}}],
+ ]),
+ }),
+ ).toContain(
+ `release sync changed non-version manifest fields: ${manifestPath}`,
+ );
+ });
+
it('rejects changes to post-cut Changesets and non-bookkeeping paths', () => {
expect(
sync({
@@ -410,22 +457,19 @@ describe('post-release bookkeeping sync', () => {
);
});
- it('rejects missing frozen deletions and release-output drift', () => {
+ it('rejects missing frozen deletions and exact-output drift', () => {
expect(
sync({
headChangesets: new Map([
['.changeset/frozen.md', digest('a')],
['.changeset/post-cut.md', digest('c')],
]),
- headOutputs: new Map([
- ['packages/core/package.json', digest('f')],
- ['packages/core/CHANGELOG.md', digest('e')],
- ]),
+ headOutputs: new Map([['packages/core/CHANGELOG.md', digest('f')]]),
}),
).toEqual(
expect.arrayContaining([
'release sync did not delete frozen Changeset: .changeset/frozen.md',
- 'release sync output differs from published branch: packages/core/package.json',
+ 'release sync output differs from published branch: packages/core/CHANGELOG.md',
]),
);
});