CI: duplicate-PR check and a 'Changes a default' line (Refs #6439) (#6442)

* CI: duplicate-PR check and a required 'Changes a default' line (Refs #6439)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* PR checks: enforce the defaults line only on PRs opened from 2026-10-25 (Refs #6439)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bherbruck
2026-10-25 02:28:57 +00:00
committed by GitHub
parent 2741cd9a8b
commit 78de687902
7 changed files with 377 additions and 1 deletions
+146
View File
@@ -0,0 +1,146 @@
// Pull request checks for .github/workflows/pr-checks.yml (CONTRIBUTING.md, "Sending a change"):
// 1. duplicate: fails when a lower-numbered open PR already closes the same issue;
// 2. defaults: the template line `Changes a default: no | yes - <what>, old behaviour kept behind
// preference <name>` must be present and well formed; `yes` earns the `changes-default` label.
// The parsing is pure and tested in scripts/pr-checks/pr-checks.test.js; the functions that talk to
// GitHub take the github-script `github` client and `context`, so the tests can pass fakes.
'use strict';
const SKIP_LABEL = 'not-a-duplicate';
const DEFAULT_LABEL = 'changes-default';
// PRs opened before this predate the template line; they pass the defaults check with a notice.
const DEFAULTS_ENFORCED_FROM = Date.parse('2026-10-25T00:00:00Z');
const BOT_LOGINS = new Set(['dependabot[bot]', 'github-actions[bot]', 'dependabot-preview[bot]']);
// Template comments and code blocks hold examples, not claims.
function stripNoise(body, { inlineCode = true } = {}) {
const text = String(body || '')
.replace(/<!--[\s\S]*?-->/g, '')
.replace(/```[\s\S]*?```/g, '')
.replace(/~~~[\s\S]*?~~~/g, '');
return inlineCode ? text.replace(/`[^`\n]*`/g, '') : text;
}
// Issue numbers after a closing keyword: Fixes #1, closes: #2, Resolved owner/repo#3.
// A list ("Fixes #1, #2") counts every number; a URL to another repo does not.
function parseClosing(body, repoFullName) {
const text = stripNoise(body);
const found = new Set();
const re = /\b(?:close[sd]?|fix(?:e[sd])?|resolve[sd]?)\b:?[ \t]+((?:(?:[\w.-]+\/[\w.-]+)?#\d+(?:[ \t]*(?:,|and|&)[ \t]*)?)+)/gi;
for (const m of text.matchAll(re)) {
for (const ref of m[1].matchAll(/(?:([\w.-]+\/[\w.-]+))?#(\d+)/g)) {
if (ref[1] && repoFullName && ref[1].toLowerCase() !== repoFullName.toLowerCase()) continue;
found.add(Number(ref[2]));
}
}
return [...found].sort((a, b) => a - b);
}
// -> { status: 'missing' | 'malformed' | 'no' | 'yes', preference?, detail? }
function parseDefaults(body) {
const m = stripNoise(body, { inlineCode: false }).replace(/\*\*/g, '').match(/^[ \t]*(?:[-*][ \t]+)?Changes a default:[ \t]*(.*?)[ \t]*$/im);
if (!m) return { status: 'missing' };
const value = m[1].replace(/\*\*/g, '').trim();
if (/^no\.?$/i.test(value)) return { status: 'no' };
const yes = value.match(/^yes\b[ \t]*(?:—|–|->|→|-{1,2}|:)[ \t]*(.+)$/i);
if (yes) {
const pref = yes[1].match(/^(.*?)[ ,;]*\bold (?:behaviou?r|value) kept behind (?:preference|pref|setting)[ \t]+`?([\w.:/-]+)`?\.?$/i);
if (pref && pref[1].trim() && !/^<.*>$/.test(pref[2])) {
return { status: 'yes', detail: pref[1].trim(), preference: pref[2] };
}
}
return { status: 'malformed', detail: value };
}
const DEFAULTS_HELP =
'Add one line to the description: `Changes a default: no`, or ' +
'`Changes a default: yes — <what>, old behaviour kept behind preference <name>`.';
function isBot(user) {
return !!user && (user.type === 'Bot' || BOT_LOGINS.has(user.login) || /\[bot\]$/.test(user.login || ''));
}
const DOC_FILE = /(^docs\/|\.md$|^LICENSE|^\.github\/ISSUE_TEMPLATE\/|^\.github\/pull_request_template\.md$)/;
function isDocsOnly(files) {
return files.length > 0 && files.every((f) => DOC_FILE.test(f));
}
// Open PRs with a lower number than `number` that close one of `issues`, by someone else.
// `pulls` is a list of REST pull objects.
function findDuplicates({ number, author, issues, pulls, repoFullName }) {
const out = [];
for (const p of pulls) {
if (p.number >= number || p.state !== 'open') continue;
if (p.user && p.user.login === author) continue; // stacked work by the same author
if ((p.labels || []).some((l) => l.name === SKIP_LABEL)) continue;
const shared = parseClosing(p.body, repoFullName).filter((n) => issues.includes(n));
if (shared.length) out.push({ number: p.number, title: p.title, url: p.html_url, draft: !!p.draft, issues: shared });
}
return out.sort((a, b) => a.number - b.number);
}
function hasLabel(pull, name) {
return (pull.labels || []).some((l) => l.name === name);
}
async function checkDuplicate({ github, context, core }) {
const pull = context.payload.pull_request;
const repoFullName = `${context.repo.owner}/${context.repo.repo}`;
if (isBot(pull.user)) return { skipped: 'bot' };
if (hasLabel(pull, SKIP_LABEL)) return { skipped: SKIP_LABEL };
const issues = parseClosing(pull.body, repoFullName);
if (!issues.length) return { skipped: 'no closing keyword' };
const pulls = await github.paginate(github.rest.pulls.list, {
...context.repo, state: 'open', per_page: 100,
});
const dups = findDuplicates({ number: pull.number, author: pull.user.login, issues, pulls, repoFullName });
if (!dups.length) return { dups };
const lines = dups.map(
(d) => ` #${d.number}${d.draft ? ' (draft)' : ''} ${d.title}\n ${d.url} (closes ${d.issues.map((n) => '#' + n).join(', ')})`,
);
core.setFailed(
`A lower-numbered open pull request already closes the same issue, and the lowest number wins:\n${lines.join('\n')}\n` +
`Close this one or help on that one. If this is not a duplicate (a different fix that happens to name the same issue), ` +
`change "Fixes" to "Refs" or ask a maintainer to add the \`${SKIP_LABEL}\` label.`,
);
return { dups };
}
async function checkDefaults({ github, context, core }) {
const pull = context.payload.pull_request;
if (isBot(pull.user)) return { skipped: 'bot' };
if (!(Date.parse(pull.created_at) >= DEFAULTS_ENFORCED_FROM)) {
core.notice('The "Changes a default:" line is only enforced on pull requests opened on or after 2026-10-25; this one predates it. Please add the line when you next push.');
return { skipped: 'opened before enforcement' };
}
const files = (await github.paginate(github.rest.pulls.listFiles, {
...context.repo, pull_number: pull.number, per_page: 100,
})).map((f) => f.filename);
if (isDocsOnly(files)) return { skipped: 'docs only' };
const result = parseDefaults(pull.body);
if (result.status === 'missing') {
core.setFailed(`The description has no "Changes a default:" line. ${DEFAULTS_HELP}`);
} else if (result.status === 'malformed') {
core.setFailed(`Could not read "Changes a default: ${result.detail}". ${DEFAULTS_HELP}`);
}
return result;
}
// Separate job (it needs write access, which fork PRs don't get): best effort.
async function syncDefaultLabel({ github, context, core }) {
const pull = context.payload.pull_request;
const { status } = parseDefaults(pull.body);
const has = hasLabel(pull, DEFAULT_LABEL);
const args = { ...context.repo, issue_number: pull.number };
if (status === 'yes' && !has) {
await github.rest.issues.addLabels({ ...args, labels: [DEFAULT_LABEL] });
} else if (status !== 'yes' && has) {
await github.rest.issues.removeLabel({ ...args, name: DEFAULT_LABEL });
}
core.info(`Defaults line: ${status}`);
}
module.exports = {
DEFAULTS_ENFORCED_FROM, SKIP_LABEL, DEFAULT_LABEL, stripNoise, parseClosing, parseDefaults, isBot, isDocsOnly,
findDuplicates, checkDuplicate, checkDefaults, syncDefaultLabel,
};
+148
View File
@@ -0,0 +1,148 @@
'use strict';
const test = require('node:test');
const assert = require('node:assert/strict');
const pc = require('./pr-checks.js');
const REPO = 'tangency-labs/solidcraft';
test('parseClosing finds closing keywords only', () => {
assert.deepEqual(pc.parseClosing('Fixes #12', REPO), [12]);
assert.deepEqual(pc.parseClosing('closes: #3\nResolved #4', REPO), [3, 4]);
assert.deepEqual(pc.parseClosing('Fixes #5, #6 and #7', REPO), [5, 6, 7]);
assert.deepEqual(pc.parseClosing('Fix #8', REPO), [8]);
assert.deepEqual(pc.parseClosing('Refs #9\nSee #10\nrelated to #11', REPO), []);
assert.deepEqual(pc.parseClosing('Prefixes #1 and suffix fixes#2', REPO), []);
assert.deepEqual(pc.parseClosing(null, REPO), []);
});
test('parseClosing handles repo-qualified refs, comments and code', () => {
assert.deepEqual(pc.parseClosing(`Fixes ${REPO}#20`, REPO), [20]);
assert.deepEqual(pc.parseClosing('Fixes other/repo#21', REPO), []);
assert.deepEqual(pc.parseClosing('<!-- Fixes #22 -->', REPO), []);
assert.deepEqual(pc.parseClosing('```\nFixes #23\n```\nFixes #24', REPO), [24]);
assert.deepEqual(pc.parseClosing('say `Fixes #25` to close', REPO), []);
});
test('parseDefaults', () => {
assert.equal(pc.parseDefaults('x').status, 'missing');
assert.equal(pc.parseDefaults('<!-- Changes a default: no -->').status, 'missing');
assert.equal(pc.parseDefaults('Changes a default: no').status, 'no');
assert.equal(pc.parseDefaults('- Changes a default: No.\r\nmore').status, 'no');
assert.equal(pc.parseDefaults('**Changes a default:** no').status, 'no');
assert.equal(pc.parseDefaults('Changes a default: <no | yes — <what>, old behaviour kept behind preference <name>>').status, 'malformed');
assert.equal(pc.parseDefaults('Changes a default:').status, 'malformed');
assert.equal(pc.parseDefaults('Changes a default: maybe').status, 'malformed');
assert.equal(pc.parseDefaults('Changes a default: yes').status, 'malformed');
assert.equal(pc.parseDefaults('Changes a default: yes - faster zoom').status, 'malformed');
});
test('parseDefaults yes forms', () => {
for (const sep of ['—', '–', '-', '->', '→', ':']) {
const r = pc.parseDefaults(`Changes a default: yes ${sep} zoom speed doubled, old behaviour kept behind preference viewport.zoom_speed`);
assert.equal(r.status, 'yes', sep);
assert.equal(r.preference, 'viewport.zoom_speed');
assert.equal(r.detail, 'zoom speed doubled');
}
assert.equal(pc.parseDefaults('Changes a default: yes — x, old value kept behind preference `p`').status, 'yes');
assert.equal(pc.parseDefaults('Changes a default: yes — x, old behaviour kept behind preference <name>').status, 'malformed');
});
test('isBot and isDocsOnly', () => {
assert.ok(pc.isBot({ login: 'dependabot[bot]', type: 'Bot' }));
assert.ok(pc.isBot({ login: 'solidcraft-generated[bot]' }));
assert.ok(!pc.isBot({ login: 'alice', type: 'User' }));
assert.ok(pc.isDocsOnly(['README.md', 'docs/a.png']));
assert.ok(!pc.isDocsOnly(['README.md', 'crates/a.rs']));
assert.ok(!pc.isDocsOnly([]));
});
const mk = (number, login, body, extra = {}) => ({
number, state: 'open', user: { login }, body, title: `t${number}`,
html_url: `https://github.com/${REPO}/pull/${number}`, labels: [], ...extra,
});
test('findDuplicates: lower number, other author, same issue', () => {
const pulls = [
mk(10, 'bob', 'Fixes #5'),
mk(11, 'carol', 'Fixes #6'),
mk(12, 'alice', 'Fixes #5'),
mk(13, 'dan', 'Refs #5'),
mk(14, 'erin', 'Closes #5', { draft: true }),
mk(15, 'fay', 'Fixes #5', { labels: [{ name: 'not-a-duplicate' }] }),
mk(30, 'gus', 'Fixes #5'),
mk(16, 'hal', 'Fixes #5', { state: 'closed' }),
];
const d = pc.findDuplicates({ number: 20, author: 'alice', issues: [5], pulls, repoFullName: REPO });
assert.deepEqual(d.map((x) => x.number), [10, 14]);
assert.ok(d[1].draft);
});
function fakes(pull, { pulls = [], files = [] } = {}) {
const calls = [];
const github = {
paginate: async (fn) => (fn === 'list' ? pulls : files),
rest: {
pulls: { list: 'list', listFiles: 'files' },
issues: {
addLabels: async (a) => calls.push(['add', a.labels]),
removeLabel: async (a) => calls.push(['remove', a.name]),
},
},
};
const failures = [];
const core = { setFailed: (m) => failures.push(m), info() {}, notice() {} };
const context = { repo: { owner: 'tangency-labs', repo: 'solidcraft' }, payload: { pull_request: pull } };
return { github, core, context, calls, failures };
}
test('checkDuplicate fails with links, skips on label and bots', async () => {
const me = mk(20, 'alice', 'Fixes #5');
let f = fakes(me, { pulls: [mk(10, 'bob', 'Fixes #5')] });
await pc.checkDuplicate(f);
assert.equal(f.failures.length, 1);
assert.match(f.failures[0], /pull\/10/);
f = fakes({ ...me, labels: [{ name: 'not-a-duplicate' }] }, { pulls: [mk(10, 'bob', 'Fixes #5')] });
await pc.checkDuplicate(f);
assert.equal(f.failures.length, 0);
f = fakes({ ...me, user: { login: 'dependabot[bot]', type: 'Bot' } }, { pulls: [mk(10, 'bob', 'Fixes #5')] });
await pc.checkDuplicate(f);
assert.equal(f.failures.length, 0);
});
test('checkDefaults fails when missing, passes docs-only and bots', async () => {
const me = mk(20, 'alice', 'Fixes #5', { created_at: '2026-10-25T00:00:00Z' });
let f = fakes(me, { files: [{ filename: 'crates/a.rs' }] });
await pc.checkDefaults(f);
assert.equal(f.failures.length, 1);
f = fakes(me, { files: [{ filename: 'docs/a.md' }] });
await pc.checkDefaults(f);
assert.equal(f.failures.length, 0);
f = fakes({ ...me, body: 'Changes a default: no' }, { files: [{ filename: 'crates/a.rs' }] });
await pc.checkDefaults(f);
assert.equal(f.failures.length, 0);
});
test('syncDefaultLabel adds and removes', async () => {
const yes = 'Changes a default: yes — a, old behaviour kept behind preference p';
let f = fakes(mk(1, 'a', yes));
await pc.syncDefaultLabel(f);
assert.deepEqual(f.calls, [['add', ['changes-default']]]);
f = fakes(mk(1, 'a', 'Changes a default: no', { labels: [{ name: 'changes-default' }] }));
await pc.syncDefaultLabel(f);
assert.deepEqual(f.calls, [['remove', 'changes-default']]);
});
test('checkDefaults only enforces from 2026-10-25', async () => {
const files = [{ filename: 'crates/a.rs' }];
const old = mk(20, 'alice', 'Fixes #5', { created_at: '2026-10-24T23:59:59Z' });
let f = fakes(old, { files });
assert.deepEqual(await pc.checkDefaults(f), { skipped: 'opened before enforcement' });
assert.equal(f.failures.length, 0);
f = fakes({ ...old, created_at: '2026-10-25T00:00:00Z' }, { files });
await pc.checkDefaults(f);
assert.equal(f.failures.length, 1);
});