Check the changelog section of pull request descriptions in CI

Ports the clusterio versions of the changelog scripts. pr_to_changelog.mts
gains the Contributors and Statistics blocks and a shared
checkPullRequestBody, which check_pr_changelog.mts runs on every pull
request through the new Changelog workflow. The latest release is now the
newest one targeting main. Adds the pull request template the check
expects, and node --test runs the script tests in Node.js CI.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-11-19 14:32:21 +00:00
1 parent b513b7a637
commit 3687a7a527
8 files changed
+305 -25

No files matched your search

+71
View File
@@ -0,0 +1,71 @@
// Checks the changelog section of a pull request body, read from the PR_BODY environment variable.
import fs from "node:fs";
import { checkPullRequestBody, changelogSections } from "./pr_to_changelog.mts";
const expectedFormat = [
"### Changelog",
"```",
"### Features",
"- Added doodad to web interface. #123",
"",
"### Fixes",
"- Fixed doodad not showing up. #456",
"```",
"",
"Or, when nothing user facing changed, replace the code block with:",
"",
"### Changelog",
"None. Reason no change log is required.",
].join("\n");
/** Returns the problems found in the body, an empty list means it is valid. */
export function findChangelogProblems(body: string | null | undefined) {
const { error, warnings } = checkPullRequestBody(body);
return error ? [error] : warnings;
}
function escapeAnnotation(text: string) {
return text.replaceAll("%", "%25").replaceAll("\r", "%0D").replaceAll("\n", "%0A");
}
function main() {
const problems = findChangelogProblems(process.env.PR_BODY);
const summaryPath = process.env.GITHUB_STEP_SUMMARY;
if (!problems.length) {
console.log("Changelog section is valid.");
if (summaryPath) {
fs.appendFileSync(summaryPath, "Changelog section is valid.\n");
}
return;
}
for (const problem of problems) {
console.log(`::error title=Invalid changelog::${escapeAnnotation(problem)}`);
}
const rules = `Valid sections are ${changelogSections.join(", ")}. ` +
"Each entry must reference an issue, or this pull request if there is no issue.";
console.log(`\n${rules}`);
console.log(`Expected format in the pull request description:\n\n${expectedFormat}`);
if (summaryPath) {
fs.appendFileSync(summaryPath, [
"## Invalid changelog",
"",
"The changelog section of the pull request description has problems:",
"",
...problems.map(problem => `- ${problem.replaceAll("<", "&lt;")}`),
"",
rules,
"Edit the description and this check runs again. Expected format:",
"",
"````markdown",
expectedFormat,
"````",
"",
].join("\n"));
}
process.exitCode = 1;
}
if (import.meta.main) {
main();
}
+17 -2
View File
@@ -11,8 +11,8 @@ export async function githubFetch(
init = {
...init,
headers: {
...init.headers as Record<string, string> ?? {},
"Accept": "application/vnd.github+json",
...init.headers as Record<string, string> ?? {},
}
};
if (process.env.GH_TOKEN) {
@@ -24,7 +24,9 @@ export async function githubFetch(
console.log(response.headers);
throw new Error(`GitHub replied with ${response.status} ${response.statusText}: ${await response.text()}`);
}
if (!response.headers.get("Content-Type")?.startsWith("application/json")) {
const accept = init.headers!["Accept"];
const contentType = accept === "application/vnd.github+json" ? "application/json" : accept;
if (!response.headers.get("Content-Type")?.startsWith(contentType)) {
throw new Error(
`GitHub replied with ${response.status} ${response.statusText}: ${response.headers.get("Content-Type")}`
);
@@ -41,6 +43,15 @@ export async function githubFetchJson<T>(
return await response.json();
}
export async function githubFetchText(
path: string,
query: Record<string, string> = {},
init: RequestInit & { headers?: Record<string, string> } = {},
): Promise<string> {
const response = await githubFetch(path, query, init);
return await response.text();
}
export async function githubFetchJsonPaginated<T>(
path: string,
query: Record<string, string> = {},
@@ -117,6 +128,10 @@ export interface Release {
updated_at?: string | null,
}
export interface Comparison {
total_commits: number,
}
export interface Commit {
sha: string,
commit: {
+100 -23
View File
@@ -1,16 +1,26 @@
import {
type Comparison,
type Release,
type Issue,
githubFetchJson,
githubFetchJsonPaginated,
githubFetchText,
} from "./github_api.mts";
type Changelog = Record<string, string[]>;
type Statistics = {
commits: number,
pullRequests: number,
filesChanged: number,
lineAdditions: number,
lineDeletions: number,
};
const repository = "explosivegaming/ExpCluster";
const branch = "main";
const changelogSections = [
export const changelogSections = [
"Major Features",
"Features",
"Fixes",
@@ -69,7 +79,7 @@ function extractPullRequestChangelog(
{
const headerFail = skipToLine(parser, /^###? Changelog *$/);
if (headerFail) {
return [failure, , "Header not found"];
return [failure, , "\"### Changelog\" header not found"];
}
parser.pos += 1;
skipEmptyLines(parser);
@@ -87,10 +97,19 @@ function extractPullRequestChangelog(
if (blockEndFail) {
return [failure, , "End of code block not found after header"];
}
return [success, parser.lines.slice(blockStartPos, parser.pos)];
const lines = parser.lines.slice(blockStartPos, parser.pos);
if (!lines.some(line => line.trim() !== "")) {
return [failure, , "Code block is empty, replace it with \"None.\" if nothing applies"];
}
return [success, lines];
}
function parseChangelog(parser: ParserState, pr: Issue, issues: Issue[]): [Changelog, string[]] {
/** Pass no issues to skip the checks that need the GitHub API. */
function parseChangelog(
parser: ParserState,
pr?: Issue,
issues?: Issue[],
): [Changelog, string[]] {
let section: string | undefined;
let changelog: Changelog = Object.create(null);
let warnings: string[] = [];
@@ -110,6 +129,10 @@ function parseChangelog(parser: ParserState, pr: Issue, issues: Issue[]): [Chang
changelog[section] = changelog[section] ?? [];
continue;
}
if (!section && /^None/i.test(line)) {
warnings.push(`"${line}" on line ${parser.pos} must replace the code block, not sit inside it`);
continue;
}
if (!section) {
warnings.push(`Unexpected content "${line}" outside of a changelog section on line ${parser.pos}`);
continue;
@@ -122,6 +145,9 @@ function parseChangelog(parser: ParserState, pr: Issue, issues: Issue[]): [Chang
let hasRef = false
for (const ref of entry.matchAll(/#(\d+)/g)) {
hasRef = true;
if (!issues || !pr) {
continue;
}
const id = Number.parseInt(ref[1], 10);
const refIssue = issues.find(issue => issue.number === id);
if (!refIssue) {
@@ -147,26 +173,34 @@ function parseChangelog(parser: ParserState, pr: Issue, issues: Issue[]): [Chang
return [changelog, warnings];
}
export function checkPullRequestBody(
body: string | null | undefined,
pr?: Issue,
issues?: Issue[],
): { changelog: Changelog, error?: string, warnings: string[] } {
if (!body) {
return { changelog: Object.create(null), error: "Pull request has no body", warnings: [] };
}
const [
changelogFail,
changelogLines,
changelogFailReason
] = extractPullRequestChangelog(createParser(body.split(/\r?\n/)));
if (changelogFail) {
return { changelog: Object.create(null), error: changelogFailReason, warnings: [] };
}
const [changelog, warnings] = parseChangelog(createParser(changelogLines), pr, issues);
return { changelog, warnings };
}
function changelogFromPullRequests(pullRequests: Issue[], issues: Issue[]) {
const mergedChangelog: Changelog = Object.create(null);
for (const pr of pullRequests) {
if (!pr.body) {
console.error(`Failed to extract changelog in ${pr.html_url}: No body`)
console.log(pr.title)
const { changelog, error, warnings } = checkPullRequestBody(pr.body, pr, issues);
if (error) {
console.error(`Failed to extract changelog in ${pr.html_url}: ${error}`)
continue;
}
const [
changelogFail,
changelogLines,
changelogFailReason
] = extractPullRequestChangelog(createParser(pr.body!.split(/\r?\n/)));
if (changelogFail) {
console.error(`Failed to extract changelog in ${pr.html_url}: ${changelogFailReason}`)
console.log(pr.title)
console.log(pr.body)
continue;
}
const [changelog, warnings] = parseChangelog(createParser(changelogLines), pr, issues);
for (const warning of warnings) {
console.warn(`Warning in changelog for ${pr.html_url}: ${warning}`)
}
@@ -180,7 +214,7 @@ function changelogFromPullRequests(pullRequests: Issue[], issues: Issue[]) {
async function fetchLastRelease() {
// Assumes releases are ordered by their creation or tag time in descending order.
const releases = await githubFetchJson<Release[]>(`/repos/${repository}/releases`);
const latest = releases[0]
const latest = releases.find(r => r.target_commitish === branch);
if (!latest) {
throw new Error(`Unable to find latest release on ${branch}`);
}
@@ -194,10 +228,41 @@ async function fetchIssuesUpdatedSince(since: string) {
);
}
async function fetchStatistics(lastRelease: Release, pullRequests: Issue[]): Promise<Statistics> {
const path = `/repos/${repository}/compare/${lastRelease.tag_name}...${branch}`;
const comparison = await githubFetchJson<Comparison>(path, { per_page: "1" });
// The JSON response lists at most 300 files, the diff has all of them.
const diff = await githubFetchText(path, {}, { headers: { "Accept": "application/vnd.github.diff" } });
let filesChanged = 0;
let lineAdditions = 0;
let lineDeletions = 0;
let inHunk = false; // Skips the ---/+++ file headers
for (const line of diff.split("\n")) {
if (line.startsWith("diff --git ")) {
filesChanged += 1;
inHunk = false;
} else if (line.startsWith("@@")) {
inHunk = true;
} else if (inHunk && line.startsWith("+")) {
lineAdditions += 1;
} else if (inHunk && line.startsWith("-")) {
lineDeletions += 1;
}
}
return {
commits: comparison.total_commits,
pullRequests: pullRequests.length,
filesChanged,
lineAdditions,
lineDeletions,
};
}
function printMarkdown(
changelog: Changelog,
issues: Issue[],
users: Issue["user"][],
statistics: Statistics,
refText: (issue: Issue) => string,
userText: (user: Issue["user"]) => string,
) {
@@ -223,8 +288,19 @@ function printMarkdown(
}
}
console.log("### Contributors\n");
console.log(`Many thanks to the following for contributing to this release:`);
console.log(users.map(userText).join("\n"))
console.log(users.map(userText).join(", "));
const format = (value: number) => value.toLocaleString("en-US");
console.log("\n### Statistics\n");
console.log([
`Commits: ${format(statistics.commits)}`,
`Pull Requests: ${format(statistics.pullRequests)}`,
`Files Changed: ${format(statistics.filesChanged)}`,
`Additions: +${format(statistics.lineAdditions)}`,
`Deletions: -${format(statistics.lineDeletions)}`,
].join(" "));
}
async function main() {
@@ -239,17 +315,18 @@ async function main() {
const changelog = changelogFromPullRequests(pullRequests, issues);
const users = [...new Map(pullRequests.map(issue => [issue.user.login, issue.user])).values()]
const statistics = await fetchStatistics(lastRelease, pullRequests);
console.log();
console.log("=== Github Release Markdown ===");
printMarkdown(changelog, issues, users,
printMarkdown(changelog, issues, users, statistics,
issue => `${repository}#${issue.number}`,
user => `@${user.login}`,
);
console.log();
console.log("=== Discord / Changelog Markdown ===");
printMarkdown(changelog, issues, users,
printMarkdown(changelog, issues, users, statistics,
issue => `[#${issue.number}](<${issue.html_url}>)`,
user => `[@${user.login}](<${user.html_url}>)`
);