Build: Backport changelog generation from jQuery

Author: mgol

.release-it.js

@@ -5,13 +5,17 @@ module.exports = {
 	hooks: {
 		"before:init": "bash ./build/release/pre-release.sh",
 		"after:version:bump":
-            "sed -i 's/main\\/AUTHORS.txt/${version}\\/AUTHORS.txt/' package.json",
+			"sed -i 's/main\\/AUTHORS.txt/${version}\\/AUTHORS.txt/' package.json",
 		"after:bump": "cross-env VERSION=${version} npm run build",
-		"before:git:release": "git add -f dist/",
+		"before:git:release": "git add -f dist/ changelog.md",
 		"after:release": "echo 'Run the following to complete the release:' && " +
-            "echo './build/release/post-release.sh $\{version}'"
+			"echo './build/release/post-release.sh $\{version}'"
 	},
 	git: {
+
+		// Use the node script directly to avoid an npm script
+		// command log entry in the GH release notes
+		changelog: "node build/release/changelog.mjs ${from} ${to}",
 		commitMessage: "Release: ${version}",
 		getLatestTagFromAllRefs: true,
 		pushRepo: "git@github.com:jquery/jquery-mousewheel.git",

CHANGELOG.md LEGACY_CHANGELOG.md

@@ -0,0 +1,175 @@
+import { writeFile } from "node:fs/promises";
+import { argv } from "node:process";
+import { exec as nodeExec } from "node:child_process";
+import util from "node:util";
+
+const exec = util.promisify( nodeExec );
+
+const rbeforeHash = /.#$/;
+const rendsWithHash = /#$/;
+const rcherry = / \(cherry picked from commit [^)]+\)/;
+const rcommit = /Fix(?:e[sd])? ((?:[a-zA-Z0-9_-]{1,39}\/[a-zA-Z0-9_-]{1,100}#)|#|gh-)(\d+)/g;
+const rcomponent = /^([^ :]+):\s*([^\n]+)/;
+const rnewline = /\r?\n/;
+
+const prevVersion = argv[ 2 ];
+const nextVersion = argv[ 3 ];
+const blogUrl = process.env.BLOG_URL;
+
+if ( !prevVersion || !nextVersion ) {
+	throw new Error( "Usage: `node changelog.js PREV_VERSION NEXT_VERSION`" );
+}
+
+function ticketUrl( ticketId ) {
+	return `https://github.com/jquery/jquery-mousewheel/issues/${ ticketId }`;
+}
+
+function getTicketsForCommit( commit ) {
+	const tickets = [];
+
+	commit.replace( rcommit, function( _match, refType, ticketId ) {
+		const ticket = {
+			url: ticketUrl( ticketId ),
+			label: "#" + ticketId
+		};
+
+		// If the refType has anything before the #, assume it's a GitHub ref
+		if ( rbeforeHash.test( refType ) ) {
+
+			// console.log( refType );
+			refType = refType.replace( rendsWithHash, "" );
+			ticket.url = `https://github.com/${ refType }/issues/${ ticketId }`;
+			ticket.label = refType + ticket.label;
+		}
+
+		tickets.push( ticket );
+	} );
+
+	return tickets;
+}
+
+async function getCommits() {
+	const format =
+		"__COMMIT__%n%s (__TICKETREF__[%h](https://github.com/jquery/jquery-mousewheel/commit/%H))%n%b";
+	const { stdout } = await exec(
+		`git log --format="${ format }" ${ prevVersion }..${ nextVersion }`
+	);
+	const commits = stdout.split( "__COMMIT__" ).slice( 1 );
+
+	return removeReverts( commits.map( parseCommit ).sort( sortCommits ) );
+}
+
+function parseCommit( commit ) {
+	const tickets = getTicketsForCommit( commit )
+		.map( ( ticket ) => {
+			return `[${ ticket.label }](${ ticket.url })`;
+		} )
+		.join( ", " );
+
+	// Drop the commit message body
+	let message = `${ commit.trim().split( rnewline )[ 0 ] }`;
+
+	// Add any ticket references
+	message = message.replace( "__TICKETREF__", tickets ? `${ tickets }, ` : "" );
+
+	// Remove cherry-pick references
+	message = message.replace( rcherry, "" );
+
+	return message;
+}
+
+function sortCommits( a, b ) {
+	const aComponent = rcomponent.exec( a );
+	const bComponent = rcomponent.exec( b );
+
+	if ( aComponent && bComponent ) {
+		if ( aComponent[ 1 ] < bComponent[ 1 ] ) {
+			return -1;
+		}
+		if ( aComponent[ 1 ] > bComponent[ 1 ] ) {
+			return 1;
+		}
+		return 0;
+	}
+
+	if ( a < b ) {
+		return -1;
+	}
+	if ( a > b ) {
+		return 1;
+	}
+	return 0;
+}
+
+/**
+ * Remove all revert commits and the commit it is reverting
+ */
+function removeReverts( commits ) {
+	const remove = [];
+
+	commits.forEach( function( commit ) {
+		const match = /\*\s*Revert "([^"]*)"/.exec( commit );
+
+		// Ignore double reverts
+		if ( match && !/^Revert "([^"]*)"/.test( match[ 0 ] ) ) {
+			remove.push( commit, match[ 0 ] );
+		}
+	} );
+
+	remove.forEach( function( message ) {
+		const index = commits.findIndex( ( commit ) => commit.includes( message ) );
+		if ( index > -1 ) {
+
+			// console.log( "Removing", commits[ index ] );
+			commits.splice( index, 1 );
+		}
+	} );
+
+	return commits;
+}
+
+function addHeaders( commits ) {
+	const components = {};
+	let markdown = "";
+
+	commits.forEach( function( commit ) {
+		const match = rcomponent.exec( commit );
+		if ( match ) {
+			let component = match[ 1 ];
+			if ( !/^[A-Z]/.test( component ) ) {
+				component =
+					component.slice( 0, 1 ).toUpperCase() +
+					component.slice( 1 ).toLowerCase();
+			}
+			if ( !components[ component.toLowerCase() ] ) {
+				markdown += "\n## " + component + "\n\n";
+				components[ component.toLowerCase() ] = true;
+			}
+			markdown += `- ${ match[ 2 ] }\n`;
+		} else {
+			markdown += `- ${ commit }\n`;
+		}
+	} );
+
+	return markdown;
+}
+
+async function generate() {
+	const commits = await getCommits();
+
+	let changelog = "# Changelog\n";
+	if ( blogUrl ) {
+		changelog += `\n${ blogUrl }\n`;
+	}
+	changelog += addHeaders( commits );
+
+	// Write markdown to changelog.md
+	await writeFile( "changelog.md", changelog );
+
+	// Log regular changelog for release-it
+	console.log( changelog );
+
+	return changelog;
+}
+
+generate();

build/release/changelog.mjs

@@ -2,8 +2,6 @@
 
 set -euo pipefail
 
-read -p "Press enter if you updated CHANGELOG.md; abort otherwise"
-
 # Install dependencies
 npm ci
 

build/release/pre-release.sh

@@ -26,7 +26,7 @@
     "browser"
   ],
   "files": [
-    "CHANGELOG.md",
+    "changelog.md",
     "dist/jquery.mousewheel.js",
     "dist/jquery.mousewheel.min.js",
     "README.md",