jquery/build/release/authors.js
Timmy Willison 2cf659189e Release: migrate release process to release-it
*Authors*
- Checking and updating authors has been migrated
  to a custom script in the repo

*Changelog*
- changelogplease is no longer maintained
- generate changelog in markdown for GitHub releases
- generate changelog in HTML for blog posts
- generate contributors list in HTML for blog posts

*dist*
- clone dist repo, copy files, and commit/push
- commit tag with dist files on main branch;
  remove dist files from main branch after release

*cdn*
- clone cdn repo, copy files, and commit/push
- create versioned and unversioned copies in cdn/
- generate md5 sums and archives for Google and MSFT

*build*
- implement reproducible builds and verify release builds
  * uses the last modified date for the latest commit
  * See https://reproducible-builds.org/
- the verify workflow also ensures all files were
  properly published to the CDN and npm

*docs*
- the new release workflow is documented at build/release/README.md

*verify*
- use the last modified date of the commit before the tag
- use versioned filenames when checking map files on the CDN
- skip factory and package.json files when verifying CDN

*misc*
- now that we don't need the jquery-release script and
  now that we no longer need to build on Node 10, we can
  use ESM in all files in the build folder
- limit certain workflows to the main repo (not forks)
- version has been set to the previously released version 3.7.1,
  as release-it expects
- release-it added the `preReleaseBase` option and we
  now always set it to `1` in the npm script. This is
  a noop for stable releases.
- include post-release script to be run manually after a release,
  with further steps that should be verified manually

Ref jquery/jquery-release#114
Closes gh-5522
2024-07-29 15:25:14 -04:00

103 lines
2.6 KiB
JavaScript

import fs from "node:fs/promises";
import util from "node:util";
import { exec as nodeExec } from "node:child_process";
const exec = util.promisify( nodeExec );
const rnewline = /\r?\n/;
const rdate = /^\[(\d+)\] /;
const ignore = [
/dependabot\[bot\]/
];
function compareAuthors( a, b ) {
const aName = a.replace( rdate, "" ).replace( / <.*>/, "" );
const bName = b.replace( rdate, "" ).replace( / <.*>/, "" );
return aName === bName;
}
function uniq( arr ) {
const unique = [];
for ( const item of arr ) {
if ( ignore.some( re => re.test( item ) ) ) {
continue;
}
if ( item && !unique.find( ( e ) => compareAuthors( e, item ) ) ) {
unique.push( item );
}
}
return unique;
}
function cleanupSizzle() {
console.log( "Cleaning up..." );
return exec( "npx rimraf .sizzle" );
}
function cloneSizzle() {
console.log( "Cloning Sizzle..." );
return exec( "git clone https://github.com/jquery/sizzle .sizzle" );
}
async function getLastAuthor() {
const authorsTxt = await fs.readFile( "AUTHORS.txt", "utf8" );
return authorsTxt.trim().split( rnewline ).pop();
}
async function logAuthors( preCommand ) {
let command = "git log --pretty=format:\"[%at] %aN <%aE>\"";
if ( preCommand ) {
command = `${ preCommand } && ${ command }`;
}
const { stdout } = await exec( command );
return uniq( stdout.trim().split( rnewline ).reverse() );
}
async function getSizzleAuthors() {
await cloneSizzle();
const authors = await logAuthors( "cd .sizzle" );
await cleanupSizzle();
return authors;
}
function sortAuthors( a, b ) {
const [ , aDate ] = rdate.exec( a );
const [ , bDate ] = rdate.exec( b );
return Number( aDate ) - Number( bDate );
}
function formatAuthor( author ) {
return author.replace( rdate, "" );
}
export async function getAuthors() {
console.log( "Getting authors..." );
const authors = await logAuthors();
const sizzleAuthors = await getSizzleAuthors();
return uniq( authors.concat( sizzleAuthors ) ).sort( sortAuthors ).map( formatAuthor );
}
export async function checkAuthors() {
const authors = await getAuthors();
const lastAuthor = await getLastAuthor();
if ( authors[ authors.length - 1 ] !== lastAuthor ) {
console.log( "AUTHORS.txt: ", lastAuthor );
console.log( "Last 20 in git: ", authors.slice( -20 ) );
throw new Error( "Last author in AUTHORS.txt does not match last git author" );
}
console.log( "AUTHORS.txt is up to date" );
}
export async function updateAuthors() {
const authors = await getAuthors();
const authorsTxt = "Authors ordered by first contribution.\n\n" + authors.join( "\n" ) + "\n";
await fs.writeFile( "AUTHORS.txt", authorsTxt );
console.log( "AUTHORS.txt updated" );
}