Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions scripts/check-immutable-release-artifacts.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,6 @@ function parseNameStatus(output) {
});
}

const RETIRED_PRERELEASE_RE = /-beta\.\d+$/;

/**
* Beta checkpoints are superseded once a release candidate exists. Deleting a
* whole beta artifact tree is allowed so the repository and runtime image can
* retire it; editing it in place, or deleting rc/stable artifacts, still fails.
*/
function isRetiredPrereleaseDeletion(status, version) {
return String(status).startsWith('D') && RETIRED_PRERELEASE_RE.test(version);
}

function findImmutableArtifactViolations(changes, hasPathAtBase, isReleasedVersion = () => true) {
const violations = [];

Expand All @@ -80,7 +69,6 @@ function findImmutableArtifactViolations(changes, hasPathAtBase, isReleasedVersi
const existedAtBase = artifact.probePaths.some(hasPathAtBase);
if (!existedAtBase) continue;
if (!isReleasedVersion(artifact.version)) continue;
if (isRetiredPrereleaseDeletion(change.status, artifact.version)) continue;

violations.push({
status: change.status,
Expand Down Expand Up @@ -131,7 +119,6 @@ function formatViolationMessage(violations) {
...violations.map(v => ` - ${v.status} ${v.path}`),
'',
'Do not patch existing versioned dist artifacts in-place.',
'Only whole-tree deletions of superseded beta checkpoints are permitted.',
'Change the source files, add a changeset, and ship a new versioned artifact through Version Packages (`npm run version`).',
'Mutable development outputs such as dist/*/latest are allowed; existing dist/*/<semver> releases are not.',
];
Expand Down Expand Up @@ -163,7 +150,6 @@ if (require.main === module) {

module.exports = {
findImmutableArtifactViolations,
isRetiredPrereleaseDeletion,
formatViolationMessage,
parseImmutableArtifactPath,
parseNameStatus,
Expand Down
50 changes: 42 additions & 8 deletions tests/immutable-release-artifacts.test.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ function hasBasePath(paths) {

assert.deepStrictEqual(parseImmutableArtifactPath('dist/compliance/latest/index.json'), null);

assert.deepStrictEqual(
parseImmutableArtifactPath('.\\dist\\schemas\\3.2.0-beta.11\\index.json'),
{
kind: 'schemas',
version: '3.2.0-beta.11',
releaseRoot: 'dist/schemas/3.2.0-beta.11',
probePaths: ['dist/schemas/3.2.0-beta.11'],
}
);

assert.deepStrictEqual(
parseImmutableArtifactPath('dist/compliance/3.0.14/universal/idempotency.yaml'),
{
Expand All @@ -26,10 +36,14 @@ assert.deepStrictEqual(
);

assert.deepStrictEqual(
parseNameStatus('M\tdist/compliance/3.0.14/index.json\nR100\tdist/docs/3.0.14/a.md\tdist/docs/3.0.14/b.md\n'),
parseNameStatus(
'M\tdist/compliance/3.0.14/index.json\nD\tdist/schemas/3.0.14/index.json\nR100\tdist/docs/3.0.14/a.md\tdist/docs/3.0.14/b.md\nC100\tsource.tgz\tdist/protocol/3.0.14.tgz\n'
),
[
{ status: 'M', paths: ['dist/compliance/3.0.14/index.json'] },
{ status: 'D', paths: ['dist/schemas/3.0.14/index.json'] },
{ status: 'R100', paths: ['dist/docs/3.0.14/a.md', 'dist/docs/3.0.14/b.md'] },
{ status: 'C100', paths: ['source.tgz', 'dist/protocol/3.0.14.tgz'] },
]
);

Expand Down Expand Up @@ -84,14 +98,34 @@ violations = findImmutableArtifactViolations(
assert.deepStrictEqual(violations, [], 'Deleting artifacts for an untagged aborted release is allowed');

violations = findImmutableArtifactViolations(
[
{ status: 'D', paths: ['dist/schemas/3.2.0-beta.3/index.json'] },
{ status: 'D', paths: ['dist/compliance/3.2.0-beta.3/index.json'] },
{ status: 'D', paths: ['dist/protocol/3.2.0-beta.3.tgz'] },
],
hasBasePath(['dist/schemas/3.2.0-beta.3', 'dist/compliance/3.2.0-beta.3', 'dist/protocol/3.2.0-beta.3.tgz'])
[{ status: 'D', paths: ['dist/schemas/3.1.1/index.json'] }],
hasBasePath(['dist/schemas/3.1.1'])
);
assert.strictEqual(violations.length, 1, 'Deleting a tagged stable artifact must fail');

violations = findImmutableArtifactViolations(
[{ status: 'D', paths: ['dist/schemas/3.2.0-beta.11/index.json'] }],
hasBasePath(['dist/schemas/3.2.0-beta.11'])
);
assert.strictEqual(violations.length, 1, 'Deleting one file from a tagged beta schema must fail');

violations = findImmutableArtifactViolations(
[{ status: 'D', paths: ['dist/compliance/3.2.0-beta.11/index.json'] }],
hasBasePath(['dist/compliance/3.2.0-beta.11'])
);
assert.strictEqual(violations.length, 1, 'Deleting one file from tagged beta compliance must fail');

violations = findImmutableArtifactViolations(
[{ status: 'D', paths: ['dist/protocol/3.2.0-beta.11.tgz'] }],
hasBasePath(['dist/protocol/3.2.0-beta.11.tgz'])
);
assert.strictEqual(violations.length, 1, 'Deleting a tagged beta protocol tarball must fail');

violations = findImmutableArtifactViolations(
[{ status: 'D', paths: ['dist/protocol/3.2.0-beta.11.tgz.sig'] }],
hasBasePath(['dist/protocol/3.2.0-beta.11.tgz'])
);
assert.deepStrictEqual(violations, [], 'Retiring a tagged beta checkpoint by deleting its artifacts is allowed');
assert.strictEqual(violations.length, 1, 'Deleting a tagged beta protocol sidecar must fail');

violations = findImmutableArtifactViolations(
[{ status: 'D', paths: ['dist/schemas/3.2.0-rc.1/index.json'] }],
Expand Down
Loading