Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Reject every YAML spelling of a major bump in OK changesets (#5078)

Nick Gomezb896adf5622e
diff --git a/knip.config.ts b/knip.config.ts
index 9cf70e257..3b68578af 100644
--- a/knip.config.ts
+++ b/knip.config.ts
@@ -102,7 +102,10 @@ export default {
},
workspaces: {
'.': {
- entry: ['test-support/fixtures/no-net-connect/no-net-connect.fixture.ts'],
+ entry: [
+ 'test-support/fixtures/no-net-connect/no-net-connect.fixture.ts',
+ 'scripts/check-no-major-changeset.mjs',
+ ],
vitest: { entry: ['**/*.uncached.test.{ts,tsx,mjs}'] },
},
'packages/app': {
diff --git a/scripts/check-no-major-changeset.mjs b/scripts/check-no-major-changeset.mjs
new file mode 100644
index 000000000..f1f45ff69
--- /dev/null
+++ b/scripts/check-no-major-changeset.mjs
@@ -0,0 +1,129 @@
+import { existsSync, lstatSync, readdirSync, readFileSync, statSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { join, sep } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { parseFrontmatterBumpType, pendingChangesetFiles } from './compute-next-beta.mjs';
+import { changesetIdsFromTreePaths } from './compute-stable-version.mjs';
+
+const PASS = "No 'major' bumps in changesets.";
+const root = fileURLToPath(new URL('..', import.meta.url));
+const changesetDir = join(root, '.changeset');
+
+function loadChangesets() {
+ const cliRequire = createRequire(
+ createRequire(join(root, 'package.json')).resolve('@changesets/cli/package.json'),
+ );
+ const readerRequire = createRequire(cliRequire.resolve('@changesets/read'));
+ return {
+ read: cliRequire('@changesets/read').default,
+ parse: readerRequire('@changesets/parse').default,
+ };
+}
+
+function parseRejection(parse, file) {
+ try {
+ parse(readFileSync(join(changesetDir, file), 'utf8'));
+ } catch (error) {
+ return error.message;
+ }
+ return null;
+}
+
+function readByChangesets(file) {
+ return !file.startsWith('.') && file.endsWith('.md') && !/^README\.md$/i.test(file);
+}
+
+function unreadableChangesets(parse, error) {
+ const rejections = readdirSync(changesetDir)
+ .filter(readByChangesets)
+ .map((file) => ({ path: `.changeset/${file}`, message: parseRejection(parse, file) }))
+ .filter(({ message }) => message !== null);
+ const paths = rejections.map(({ path }) => path);
+ return rejections.some(({ message }) => message === error.message)
+ ? paths
+ : [...paths, '.changeset'];
+}
+
+function refuse(subject, error) {
+ console.error(`::error::Refusing to report a pass: ${subject}`);
+ console.error(error.message);
+ return 1;
+}
+
+function changesetsEntryPath(id) {
+ return lstatSync(join(changesetDir, id), { throwIfNoEntry: false })?.isDirectory()
+ ? `.changeset/${id}/changes.json`
+ : `.changeset/${id}.md`;
+}
+
+function versionReaderPaths() {
+ const tree = readdirSync(changesetDir, { recursive: true })
+ .map((entry) => `.changeset/${entry.split(sep).join('/')}`)
+ .filter((path) => !statSync(join(root, path)).isDirectory());
+ return [
+ ...pendingChangesetFiles(changesetDir).map((file) => `.changeset/${file}`),
+ ...changesetIdsFromTreePaths(tree).map((id) => `.changeset/${id}.md`),
+ ];
+}
+
+export async function main() {
+ if (!existsSync(changesetDir)) {
+ console.log(PASS);
+ return 0;
+ }
+ let changesets;
+ try {
+ changesets = loadChangesets();
+ } catch (error) {
+ return refuse(`Changesets could not be loaded from ${root}`, error);
+ }
+ let entries;
+ const readRejections = [];
+ const recordReadRejection = (reason) => readRejections.push(reason);
+ process.on('unhandledRejection', recordReadRejection);
+ try {
+ entries = await changesets.read(root);
+ } catch (error) {
+ return refuse(
+ `Changesets could not read ${unreadableChangesets(changesets.parse, error).join(' ')}`,
+ error,
+ );
+ } finally {
+ process.off('unhandledRejection', recordReadRejection);
+ }
+ if (readRejections.length > 0) {
+ return refuse('Changesets could not read .changeset', readRejections[0]);
+ }
+ let violations;
+ try {
+ violations = new Set([
+ ...entries
+ .filter(({ releases }) => releases.some(({ type }) => type === 'major'))
+ .map(({ id }) => changesetsEntryPath(id)),
+ ...versionReaderPaths().filter(
+ (path) => parseFrontmatterBumpType(readFileSync(join(root, path), 'utf8')) === 'major',
+ ),
+ ]);
+ } catch (error) {
+ return refuse('the release version readers could not read .changeset', error);
+ }
+ if (violations.size > 0) {
+ console.error(
+ `::error::Forbidden 'major' bump in changeset(s): ${[...violations].sort().join(' ')}`,
+ );
+ console.error(
+ "Open Knowledge is pre-1.0 — declare 'minor' for breaking changes, 'patch' for fixes.",
+ );
+ console.error(
+ "The release version scripts read the frontmatter as raw text and count 'major' wherever it ends a line after ':' and optional whitespace, YAML comments included.",
+ );
+ console.error(
+ 'See .changeset/README.md. 1.0.0 is a deliberate team decision, not a single changeset.',
+ );
+ return 1;
+ }
+ console.log(PASS);
+ return 0;
+}
+
+if (import.meta.main) process.exitCode = await main();
diff --git a/scripts/check-no-major-changeset.sh b/scripts/check-no-major-changeset.sh
index e3aac0ebc..43ee1500c 100755
--- a/scripts/check-no-major-changeset.sh
+++ b/scripts/check-no-major-changeset.sh
@@ -3,25 +3,5 @@
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
-cd "$REPO_ROOT"
-
-shopt -s nullglob
-violations=()
-for f in .changeset/*.md; do
- [[ "$(basename "$f")" == "README.md" ]] && continue
- fm="$(awk 'NR==1 && $0 !~ /^---/ {exit} /^---/{c++; next} c==1{print} c>=2{exit}' "$f")"
- if grep -Eq ':[[:space:]]*major[[:space:]]*$' <<<"$fm"; then
- violations+=("$f")
- fi
-done
-
-if (( ${#violations[@]} > 0 )); then
- echo "::error::Forbidden 'major' bump in changeset(s): ${violations[*]}" >&2
- echo "Open Knowledge is pre-1.0 — declare 'minor' for breaking changes, 'patch' for fixes." >&2
- echo "See .changeset/README.md. 1.0.0 is a deliberate team decision, not a single changeset." >&2
- exit 1
-fi
-
-echo "No 'major' bumps in changesets."
+exec node "$SCRIPT_DIR/check-no-major-changeset.mjs"
diff --git a/scripts/compute-next-beta.mjs b/scripts/compute-next-beta.mjs
index 6f3c8cd23..8e5931b50 100644
--- a/scripts/compute-next-beta.mjs
+++ b/scripts/compute-next-beta.mjs
@@ -46,6 +46,12 @@ export function parseFrontmatterBumpType(content) {
return maxType;
}
+export function pendingChangesetFiles(dir) {
+ return readdirSync(dir)
+ .filter((f) => f.endsWith('.md') && f !== 'README.md')
+ .sort();
+}
+
function findPrevBetaTag() {
const res = spawnSync(
'gh',
@@ -222,9 +228,7 @@ function main() {
throw new Error(`No initialVersion for ${FIXED_GROUP_ANCHOR} in pre.json`);
}
- const changesetFiles = readdirSync(CHANGESET_DIR)
- .filter((f) => f.endsWith('.md') && f !== 'README.md')
- .sort();
+ const changesetFiles = pendingChangesetFiles(CHANGESET_DIR);
if (changesetFiles.length === 0) {
console.log(JSON.stringify({ skip: true, reason: 'no pending changesets' }));
return;
diff --git a/scripts/compute-stable-version.mjs b/scripts/compute-stable-version.mjs
index 0b03fdabc..1150f8a47 100644
--- a/scripts/compute-stable-version.mjs
+++ b/scripts/compute-stable-version.mjs
@@ -162,6 +162,15 @@ export function runGit(args) {
return String(res.stdout || '');
}
+export function changesetIdsFromTreePaths(paths) {
+ const ids = [];
+ for (const line of paths) {
+ const m = /^\.changeset\/(.+)\.md$/.exec(line.trim());
+ if (m && m[1] !== 'README') ids.push(m[1]);
+ }
+ return ids;
+}
+
export const realGit = {
revParse: (ref) => runGit(['rev-parse', '--verify', `${ref}^{commit}`]).trim(),
newestStableTag: () => {
@@ -171,14 +180,8 @@ export const realGit = {
}
return '';
},
- changesetIds: (sha) => {
- const ids = [];
- for (const line of runGit(['ls-tree', '-r', '--name-only', sha, '--', '.changeset']).split('\n')) {
- const m = /^\.changeset\/(.+)\.md$/.exec(line.trim());
- if (m && m[1] !== 'README') ids.push(m[1]);
- }
- return ids;
- },
+ changesetIds: (sha) =>
+ changesetIdsFromTreePaths(runGit(['ls-tree', '-r', '--name-only', sha, '--', '.changeset']).split('\n')),
isAncestor: (a, b) => {
const res = spawnSync('git', ['merge-base', '--is-ancestor', a, b], { encoding: 'utf8', env: gitCleanEnv() });
if (res.status === 0) return true;