update-version-and-changelog.js

/* eslint-disable no-console */
const fs = require( 'fs' );
const core = require( '@actions/core' );
const simpleGit = require( 'simple-git' );
const { promisify } = require( 'util' );
const exec = promisify( require( 'child_process' ).exec );

const git = simpleGit.default();

const releaseType = process.env.RELEASE_TYPE;
const VALID_RELEASE_TYPES = [ 'major', 'minor', 'patch' ];

// To get the merges since the last tag
async function getChangesSinceGitTag( tag ) {
	const changes = await git.log( [
		'--reverse',
		'--merges',
		`HEAD...${ tag }`,
	] );
	return changes;
}

// To know if there are changes since the last tag.
// we are not using getChangesSinceGitTag because it returns the just the merges and not the commits.
// So for example if a hotfix was committed directly to trunk this function will detect it but getChangesSinceGitTag will not.
async function getHasChangesSinceGitTag( tag ) {
	const changes = await git.log( [ `HEAD...${ tag }` ] );
	return changes?.all?.length > 0;
}

async function updateVersion() {
	if ( ! VALID_RELEASE_TYPES.includes( releaseType ) ) {
		console.error(
			'❌ Error: Release type is not valid. Valid release types are: major, minor, patch.'
		);
		process.exit( 1 );
	}

	if (
		! fs.existsSync( './package.json' ) ||
		! fs.existsSync( './package-lock.json' )
	) {
		console.error( '❌ Error: package.json or lock file not found.' );
		process.exit( 1 );
	}

	if ( ! fs.existsSync( './readme.txt' ) ) {
		console.error( '❌ Error: readme.txt file not found.' );
		process.exit( 1 );
	}

	if ( ! fs.existsSync( './create-block-theme.php' ) ) {
		console.error( '❌ Error: create-block-theme.php file not found.' );
		process.exit( 1 );
	}

	const packageJson = require( './package.json' );
	const currentVersion = packageJson.version;

	// version bump package.json and package-lock.json using npm
	const { stdout, stderr } = await exec(
		`npm version --commit-hooks false --git-tag-version false ${ releaseType }`
	);
	if ( stderr ) {
		console.error( `❌ Error: failed to bump the version."` );
		process.exit( 1 );
	}

	const currentTag = `v${ currentVersion }`;
	const newTag = stdout.trim();
	const newVersion = newTag.replace( 'v', '' );

	// get changes since last tag
	let changes = [];
	let hasChangesSinceGitTag = false;
	try {
		changes = await getChangesSinceGitTag( currentTag );
		hasChangesSinceGitTag = await getHasChangesSinceGitTag( currentTag );
	} catch ( e ) {
		console.error(
			`❌ Error: failed to get changes since last tag. Verify that the tag ${ currentTag } exists in the git repo.`
		);
	}

	// check if there are any changes
	if ( ! hasChangesSinceGitTag ) {
		console.error(
			`❌ No changes since last tag (${ currentTag }). There is nothing new to release.`
		);
		// revert version update
		await exec(
			`npm version --commit-hooks false --git-tag-version false ${ currentVersion }`
		);
		process.exit( 1 );
	}

	console.info( '✅ Package.json version updated', currentTag, '=>', newTag );

	// update readme.txt version with the new changelog
	const readme = fs.readFileSync( './readme.txt', 'utf8' );
	const changelogChanges = changes.all
		.map( ( change ) => `* ${ change.body || change.message }` )
		.join( '\n' );
	const newChangelog = `== Changelog ==\n\n= ${ newVersion } =\n${ changelogChanges }`;
	let newReadme = readme.replace( '== Changelog ==', newChangelog );
	// update version in readme.txt
	newReadme = newReadme.replace(
		/Stable tag: (.*)/,
		`Stable tag: ${ newVersion }`
	);
	fs.writeFileSync( './readme.txt', newReadme );
	console.info( '✅  Readme version updated', currentTag, '=>', newTag );

	// update create-block-theme.php version
	const pluginPhpFile = fs.readFileSync( './create-block-theme.php', 'utf8' );
	const newPluginPhpFile = pluginPhpFile.replace(
		/Version: (.*)/,
		`Version: ${ newVersion }`
	);
	fs.writeFileSync( './create-block-theme.php', newPluginPhpFile );
	console.info(
		'✅  create-block-theme.php file version updated',
		currentTag,
		'=>',
		newTag
	);

	// output data to be used by the next steps of the github action
	core.setOutput( 'NEW_VERSION', newVersion );
	core.setOutput( 'NEW_TAG', newTag );
	core.setOutput( 'CHANGELOG', changelogChanges );
}

updateVersion();