feat(ng-dev): handle updating the MODULE.bazel.lock file during a release

This lock has contains hashes of the package.json file. Thus it needs to be updated once the version is updating during the release.

Author: alan-agius4

ng-dev/release/publish/actions.ts

@@ -10,7 +10,11 @@ import {promises as fs, existsSync} from 'fs';
 import path, {join} from 'path';
 import semver from 'semver';
 
-import {workspaceRelativePackageJsonPath} from '../../utils/constants.js';
+import {
+  workspaceRelativeBazelModuleLock,
+  workspaceRelativeBazelWorkspace,
+  workspaceRelativePackageJsonPath,
+} from '../../utils/constants.js';
 import {AuthenticatedGitClient} from '../../utils/git/authenticated-git-client.js';
 import {isGithubApiError} from '../../utils/git/github.js';
 import githubMacros from '../../utils/git/github-macros.js';
@@ -140,6 +144,14 @@ export abstract class ReleaseAction {
     if (this.config.rulesJsInteropMode && existsSync(path.join(this.projectDir, '.aspect'))) {
       await ExternalCommands.invokeBazelUpdateAspectLockFiles(this.projectDir);
     }
+
+    if (
+      existsSync(join(this.projectDir, workspaceRelativeBazelModuleLock)) &&
+      !existsSync(join(this.projectDir, workspaceRelativeBazelWorkspace))
+    ) {
+      // Updating the lock file is only needed when not using WORKSPACES.
+      await ExternalCommands.invokeBazelModDepsUpdate(this.projectDir);
+    }
   }
 
   /*
@@ -152,6 +164,15 @@ export abstract class ReleaseAction {
       : [];
   }
 
+  /*
+   * Get the modified "MODULE.bazel.lock" if bazel modules are enabled.
+   */
+  protected getModuleBazelLockFile(): string | undefined {
+    return existsSync(join(this.projectDir, workspaceRelativeBazelModuleLock))
+      ? workspaceRelativeBazelModuleLock
+      : undefined;
+  }
+
   /** Gets the most recent commit of a specified branch. */
   protected async getLatestCommitOfBranch(branchName: string): Promise<Commit> {
     const {
@@ -225,6 +246,11 @@ export abstract class ReleaseAction {
       ...this.getAspectLockFiles(),
     ];
 
+    const bazelModuleLockFile = this.getModuleBazelLockFile();
+    if (bazelModuleLockFile) {
+      filesToCommit.push(bazelModuleLockFile);
+    }
+
     const commitMessage = getCommitMessageForRelease(newVersion);
 
     // Create a release staging commit including changelog and version bump.

ng-dev/release/publish/actions/configure-next-as-major.ts

@@ -39,10 +39,18 @@ export class ConfigureNextAsMajorAction extends ReleaseAction {
     await this.checkoutUpstreamBranch(branchName);
     await this.updateProjectVersion(newVersion);
 
-    await this.createCommit(getCommitMessageForNextBranchMajorSwitch(newVersion), [
+    const filesToCommit: string[] = [
       workspaceRelativePackageJsonPath,
       ...this.getAspectLockFiles(),
-    ]);
+    ];
+
+    const bazelModuleLockFile = this.getModuleBazelLockFile();
+    if (bazelModuleLockFile) {
+      filesToCommit.push(bazelModuleLockFile);
+    }
+
+    await this.createCommit(getCommitMessageForNextBranchMajorSwitch(newVersion), filesToCommit);
+
     const pullRequest = await this.pushChangesToForkAndCreatePullRequest(
       branchName,
       `switch-next-to-major-${newVersion}`,

ng-dev/release/publish/actions/exceptional-minor/prepare-exceptional-minor.ts

@@ -49,10 +49,20 @@ export class PrepareExceptionalMinorAction extends ReleaseAction {
       pkgJson[exceptionalMinorPackageIndicator] = true;
     });
 
-    await this.createCommit(`build: prepare exceptional minor branch: ${this._newBranch}`, [
+    const filesToCommit: string[] = [
       workspaceRelativePackageJsonPath,
       ...this.getAspectLockFiles(),
-    ]);
+    ];
+
+    const bazelModuleLockFile = this.getModuleBazelLockFile();
+    if (bazelModuleLockFile) {
+      filesToCommit.push(bazelModuleLockFile);
+    }
+
+    await this.createCommit(
+      `build: prepare exceptional minor branch: ${this._newBranch}`,
+      filesToCommit,
+    );
 
     await this.pushHeadToRemoteBranch(this._newBranch);
 

ng-dev/release/publish/actions/shared/branch-off-next-branch.ts

@@ -145,6 +145,11 @@ export abstract class BranchOffNextBranchBaseAction extends CutNpmNextPrerelease
       ...this.getAspectLockFiles(),
     ];
 
+    const bazelModuleLockFile = this.getModuleBazelLockFile();
+    if (bazelModuleLockFile) {
+      filesToCommit.push(bazelModuleLockFile);
+    }
+
     const renovateConfigPath = await updateRenovateConfig(
       this.projectDir,
       `${version.major}.${version.minor}.x`,

ng-dev/release/publish/external-commands.ts

@@ -7,7 +7,6 @@
  */
 
 import semver from 'semver';
-
 import {ChildProcess, SpawnResult, SpawnOptions} from '../../utils/child-process.js';
 import {Spinner} from '../../utils/spinner.js';
 import {NpmDistTag} from '../versioning/index.js';
@@ -263,6 +262,25 @@ export abstract class ExternalCommands {
     }
   }
 
+  /**
+   * Invokes the `bazel mod deps --lockfile_mode=update` command in order
+   * to refresh `MODULE.bazel.lock` file.
+   */
+  static async invokeBazelModDepsUpdate(projectDir: string): Promise<void> {
+    const spinner = new Spinner('Updating "MODULE.bazel.lock"');
+    try {
+      await ChildProcess.spawn(getBazelBin(), ['mod', 'dep', '--lockfile_mode=update'], {
+        cwd: projectDir,
+        mode: 'silent',
+      });
+    } catch (e) {
+      Log.error(e);
+      Log.error('  ✘   An error occurred while updating "MODULE.bazel.lock".');
+      throw new FatalReleaseActionError();
+    }
+    spinner.success(green(' Updated "MODULE.bazel.lock" file.'));
+  }
+
   /**
    * Invokes the `yarn bazel sync --only=repo` command in order
    * to refresh Aspect lock files.

ng-dev/utils/constants.ts

@@ -11,3 +11,9 @@ export const ngDevNpmPackageName = '@angular/ng-dev';
 
 /** Workspace-relative path for the "package.json" file. */
 export const workspaceRelativePackageJsonPath = 'package.json';
+
+/** Workspace-relative path for the "MODULE.bazel.lock" file. */
+export const workspaceRelativeBazelModuleLock = 'MODULE.bazel.lock';
+
+/** Workspace-relative path for the "WORKSPACE" file. */
+export const workspaceRelativeBazelWorkspace = 'WORKSPACE';