Package Release: Handle invalid releases (#33798)

tools/package-release/package.json

@@ -19,7 +19,9 @@
 	"dependencies": {
 		"@oclif/core": "^1",
 		"@oclif/plugin-help": "^5",
-		"@oclif/plugin-plugins": "^2.0.1"
+		"@oclif/plugin-plugins": "^2.0.1",
+		"@types/semver": "^7.3.10",
+		"semver": "^7.3.2"
 	},
 	"devDependencies": {
 		"@types/node": "^16.9.4",

tools/package-release/src/commands/publish/index.ts

@@ -11,6 +11,7 @@ import {
 	getAllPackges,
 	validatePackage,
 	getFilepathFromPackageName,
+	isValidUpdate,
 } from '../../validate';
 import { MONOREPO_ROOT } from '../../const';
 
@@ -79,6 +80,13 @@ export default class PackageRelease extends Command {
 				stdio: 'inherit',
 			} );
 
+			// Sometimes the pnpm lock file is out of sync, this shouldn't prevent a release.
+			execSync( 'git checkout pnpm-lock.yaml', {
+				cwd: MONOREPO_ROOT,
+				encoding: 'utf-8',
+				stdio: 'inherit',
+			} );
+
 			CliUx.ux.action.stop();
 		}
 
@@ -107,28 +115,32 @@ export default class PackageRelease extends Command {
 		{ 'dry-run': dryRun, branch }: { 'dry-run': boolean; branch: string }
 	) {
 		packages.forEach( ( name ) => {
-			const verb = dryRun ? 'Performing dry run of' : 'Publishing';
-			CliUx.ux.action.start( `${ verb } ${ name }` );
-
 			try {
-				const cwd = getFilepathFromPackageName( name );
+				const verb = dryRun ? 'Performing dry run of' : 'Publishing';
-				return execSync(
+				CliUx.ux.action.start( `${ verb } ${ name }` );
-					`SKIP_TURBO=true pnpm publish ${
+				if ( isValidUpdate( name ) ) {
-						dryRun ? '--dry-run' : ''
+					const cwd = getFilepathFromPackageName( name );
-					} --publish-branch=${ branch }`,
+					execSync(
-					{
+						`SKIP_TURBO=true pnpm publish ${
-						cwd,
+							dryRun ? '--dry-run' : ''
-						encoding: 'utf-8',
+						} --publish-branch=${ branch }`,
-						stdio: 'inherit',
+						{
-					}
+							cwd,
-				);
+							encoding: 'utf-8',
+							stdio: 'inherit',
+						}
+					);
+					CliUx.ux.action.stop( `${ name } successfully published.` );
+				} else {
+					CliUx.ux.action.stop(
+						`${ name } does not have anything to update.`
+					);
+				}
 			} catch ( e ) {
 				if ( e instanceof Error ) {
 					this.error( e.message );
 				}
 			}
-
-			CliUx.ux.action.stop();
 		} );
 	}
 }

tools/package-release/src/validate.ts

@@ -3,6 +3,8 @@
  */
 import { existsSync, readFileSync, readdirSync } from 'fs';
 import { join } from 'path';
+import { execSync } from 'child_process';
+import { gt as greaterVersionThan } from 'semver';
 
 /**
  * Internal dependencies
@@ -19,21 +21,34 @@ export const getFilepathFromPackageName = ( name: string ): string =>
 	join( MONOREPO_ROOT, 'packages/js', name.replace( '@woocommerce', '' ) );
 
 /**
- * Check if package is valid and can be deployed to NPM.
+ * Get a package's package.json file in JSON format.
  *
  * @param {string} name package name.
- * @return {boolean} true if the package is private.
+ * @return {Object|false} JSON object or false if it fails.
  */
-export const isValidPackage = ( name: string ): boolean => {
+export const getPackageJson = ( name: string ) => {
 	const filepath = getFilepathFromPackageName( name );
 	const packageJsonFilepath = `${ filepath }/package.json`;
 	const packageJsonExists = existsSync( packageJsonFilepath );
 	if ( ! packageJsonExists ) {
 		return false;
 	}
-	const packageJson = JSON.parse(
+
-		readFileSync( packageJsonFilepath, 'utf8' )
+	return JSON.parse( readFileSync( packageJsonFilepath, 'utf8' ) );
-	);
+};
+
+/**
+ * Check if package is valid and can be deployed to NPM.
+ *
+ * @param {string} name package name.
+ * @return {boolean} true if the package is private.
+ */
+export const isValidPackage = ( name: string ): boolean => {
+	const packageJson = getPackageJson( name );
+
+	if ( ! packageJson ) {
+		return false;
+	}
 
 	if ( name !== packageJson.name ) {
 		return false;
@@ -111,3 +126,29 @@ export const validatePackage = (
 		);
 	}
 };
+
+/**
+ * Determine if an update is valid by comparing version numbers.
+ *
+ * @param {string} name package name.
+ * @return {boolean} If an update is valid.
+ */
+export const isValidUpdate = ( name: string ): boolean => {
+	const packageJson = getPackageJson( name );
+
+	if ( ! packageJson ) {
+		return false;
+	}
+
+	const nextVersion = packageJson.version;
+
+	if ( ! nextVersion ) {
+		return false;
+	}
+
+	const npmVersion = execSync( 'pnpm view @woocommerce/number version', {
+		encoding: 'utf-8',
+	} );
+
+	return greaterVersionThan( nextVersion.trim(), npmVersion.trim() );
+};