GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — Incorporate change-notes into CHANGELOG.md at release by mario-campos · Pull Request #4201 · github/codeql-action

Incorporate change-notes into CHANGELOG.md at release #4201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

mbg merged 6 commits into main from mario-campos/automate-changenotes-assemble

Oct 15, 2026

Uh oh!

There was an error while loading. Please reload this page.

Merged

Incorporate change-notes into CHANGELOG.md at release #4201

Show file tree

Hide file tree

Changes from all commits

Commits

Show all changes

6 commits

Select commit Hold shift + click to select a range

9a9f454

Hoist core of `changenotes.mts assemble` into own function

mario-campos Oct 6, 2026

fb4048e

Transfer change-notes to CHANGELOG.md via update-release-branch.ts

mario-campos Oct 6, 2026

badda69

Trim whitespace of change-notes before insertion

mario-campos Oct 6, 2026

0f6901c

Commit change-note deletions

mario-campos Oct 6, 2026

aae22cc

Use config vars over hardcoded literals

mario-campos Oct 6, 2026

a7700b5

Merge branch 'main' into mario-campos/automate-changenotes-assemble

mbg Oct 14, 2026

File filter

Filter by extension .ts (2) All 1 file type selected

Viewed files

Clear filters

Conversations

Failed to load comments.

Uh oh!

There was an error while loading. Please reload this page.

Jump to

Jump to file

Failed to load files.

Uh oh!

There was an error while loading. Please reload this page.

Diff view

Unified

Split

Hide whitespace

Diff view

Unified

Split

Hide whitespace

There are no files selected for viewing

37 changes: 23 additions & 14 deletions 37 pr-checks/changenotes.ts

Show comments

View file

Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,6 +50,28 @@ function getChangenotes(): ChangenoteFile[] {
		});
		}

		/**
		* Populates the '[UNRELEASED]' section of CHANGELOG.md with the contents
		* of the changenotes in {@link CHANGENOTES_DIR} and then deletes those changenotes.
		* @param contents The contents of CHANGELOG.md
		* @returns The updated contents of CHANGELOG.md
		*/
		export function transferChangenotesToChangelog(contents: string): string {
		const changenotes = getChangenotes();
		const changenoteBodies = changenotes.map((c) => c.content.trim());
		const changenotePaths = changenotes.map((c) => c.absolutePath);

		const changelog = parseChangelog(contents);
		addBodyLinesToUnreleasedSection(changelog, changenoteBodies);
		const updatedChangelog = renderChangelog(changelog);

		for (const p of changenotePaths) {
		fs.unlinkSync(p);
		}
Comment thread mario-campos marked this conversation as resolved. Resolved Uh oh! There was an error while loading. Please reload this page.

		return updatedChangelog;
		}

		const entryPoint = process.argv[1];
		if (entryPoint && import.meta.url === pathToFileURL(entryPoint).href) {
		try {
Expand Down Expand Up		@@ -91,26 +113,13 @@ function usage(): ExitCode {

		function assemble(): ExitCode {
		try {
		const changenotes = getChangenotes();
		const changenoteBodies = changenotes.map((c) => c.content);
		const changenotePaths = changenotes.map((c) => c.absolutePath);

		withChangelog((contents) => {
		const changelog = parseChangelog(contents);
		addBodyLinesToUnreleasedSection(changelog, changenoteBodies);
		return renderChangelog(changelog);
		return transferChangenotesToChangelog(contents);
		}, {});

		// Delete changenotes only after successful processing.
		for (const p of changenotePaths) {
		fs.unlinkSync(p);
		}

		return ExitCode.Success;
		} catch (e) {
		console.error("Failed to assemble changenotes to 'CHANGELOG.md'", e);
		}

Comment thread mbg marked this conversation as resolved. Resolved Uh oh! There was an error while loading. Please reload this page.
		return ExitCode.Failure;
		}

Expand Down

15 changes: 12 additions & 3 deletions 15 pr-checks/update-release-branch.ts

Show comments

View file

Open in desktop

Comment thread

mario-campos marked this conversation as resolved.

Resolved

Uh oh!

There was an error while loading. Please reload this page.

Original file line number	Diff line number	Diff line change
Expand Up		@@ -23,7 +23,13 @@ import { parseArgs } from "node:util";

		import { type ApiClient, getApiClient } from "./api-client";
		import * as changelog from "./changelog";
		import { DryRunOption, REPO_ROOT } from "./config";
		import { transferChangenotesToChangelog } from "./changenotes";
		import {
		CHANGELOG_FILE,
		CHANGENOTES_DIR,
		DryRunOption,
		REPO_ROOT,
		} from "./config";
		import {
		getCurrentVersion,
		replaceVersionInPackageJson,
Expand Down Expand Up		@@ -693,11 +699,14 @@ export async function prepareNewBranch(

		console.log("Updating changelog");
		changelog.withChangelog(
		(contents) => changelog.setVersionAndDate(version, contents),
		(contents) => {
		const populatedContents = transferChangenotesToChangelog(contents);
		return changelog.setVersionAndDate(version, populatedContents);
		},
		{ ...options, initChangelog: true },
		);

		runGit(["add", "CHANGELOG.md"], {
		runGit(["add", CHANGELOG_FILE, CHANGENOTES_DIR], {
		dryRun: options.dryRun,
		});
		runGit(["commit", "-m", `Update changelog for v${version}`], {
Expand Down

Oops, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.