(compat) Updated build-tools to check that layer generation is updated during release

build-tools/packages/build-cli/src/commands/generate/layerCompatGeneration.ts

@@ -138,7 +138,7 @@ export function generateLayerFileContent(generation: number): string {
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 
 export const generation = ${generation};

build-tools/packages/build-cli/src/handlers/checkFunctions.ts

@@ -430,7 +430,7 @@ export const checkPolicy: StateHandlerFunction = async (
 };
 
 /**
- * Checks that a release branch exists.
+ * Checks whether assert tagging has been done.
  *
  * @param state - The current state machine state.
  * @param machine - The state machine.
@@ -903,3 +903,54 @@ export const checkValidReleaseGroup: StateHandlerFunction = async (
 
 	return true;
 };
+
+/**
+ * Checks whether layer compat generation needs to be updated.
+ *
+ * @param state - The current state machine state.
+ * @param machine - The state machine.
+ * @param testMode - Set to true to run function in test mode.
+ * @param log - A logger that the function can use for logging.
+ * @param data - An object with handler-specific contextual data.
+ * @returns True if the state was handled; false otherwise.
+ */
+export const checkLayerCompatGeneration: StateHandlerFunction = async (
+	state: MachineState,
+	machine: Machine<unknown>,
+	testMode: boolean,
+	log: CommandLogger,
+	data: FluidReleaseStateHandlerData,
+): Promise<boolean> => {
+	if (testMode) return true;
+
+	const { context, bumpType } = data;
+	const gitRepo = await context.getGitRepository();
+
+	if (bumpType === "patch") {
+		log.verbose(`Skipping layer compat generation check for patch release.`);
+		BaseStateHandler.signalSuccess(machine, state);
+		return true;
+	}
+
+	// layerGeneration:gen should be run from the root. It will only update packages that have the layerGeneration:gen
+	// script defined in their package.json.
+	const result = await execa.command(`pnpm run -r layerGeneration:gen`, {
+		cwd: context.root,
+	});
+	log.verbose(result.stdout);
+
+	// check for policy check violation
+	const afterPolicyCheckStatus = await gitRepo.gitClient.status();
+	const isClean = afterPolicyCheckStatus.isClean();
+	if (!isClean) {
+		log.logHr();
+		log.errorLog(
+			`Layer generation needs to be updated. Please create a PR for the changes and merge before retrying.\n${afterPolicyCheckStatus.files.map((fileStatus) => `${fileStatus.index} ${fileStatus.path}`).join("\n")}`,
+		);
+		BaseStateHandler.signalFailure(machine, state);
+		return false;
+	}
+
+	BaseStateHandler.signalSuccess(machine, state);
+	return true;
+};

build-tools/packages/build-cli/src/handlers/fluidReleaseStateHandler.ts

@@ -26,6 +26,7 @@ import {
 	checkDependenciesInstalled,
 	checkDoesReleaseFromReleaseBranch,
 	checkHasRemote,
+	checkLayerCompatGeneration,
 	checkMainNextIntegrated,
 	checkNoPrereleaseDependencies,
 	checkOnReleaseBranch,
@@ -163,6 +164,7 @@ export class FluidReleaseStateHandler extends InitFailedStateHandler {
 		["CheckDoesReleaseFromReleaseBranch2", checkDoesReleaseFromReleaseBranch],
 		["CheckDoesReleaseFromReleaseBranch3", checkDoesReleaseFromReleaseBranch],
 		["CheckHasRemote", checkHasRemote],
+		["CheckLayerCompatGeneration", checkLayerCompatGeneration],
 		["CheckMainNextIntegrated", checkMainNextIntegrated],
 		["CheckNoPrereleaseDependencies", checkNoPrereleaseDependencies],
 		["CheckNoPrereleaseDependencies2", checkNoPrereleaseDependencies],

build-tools/packages/build-cli/src/machines/FluidRelease.fsl

@@ -68,6 +68,7 @@ Init 'success'
 => CheckDependenciesInstalled 'success'
 => CheckPolicy 'success'
 => CheckAssertTagging 'success'
+=> CheckLayerCompatGeneration 'success'
 => CheckReleaseNotes 'success'
 => CheckChangelogs 'success'
 => CheckHasRemote 'success'
@@ -94,6 +95,10 @@ CheckPolicy
 CheckAssertTagging
 ] 'failure' -> PromptToCommitPolicy;
 
+[
+CheckLayerCompatGeneration
+] 'failure' -> PromptToCommitPolicy;
+
 [
 CheckReleaseNotes
 ] 'failure' -> PromptToGenerateReleaseNotes;