refactor(ng-dev): get the commit rather than the commit sha when getting the latest commit on the branch (#2750)

PR Close #2750

Author: josephperrott

ng-dev/release/publish/actions.ts

@@ -43,6 +43,7 @@ import {promptToInitiatePullRequestMerge} from './prompt-merge.js';
 import {Prompt} from '../../utils/prompt.js';
 import {glob} from 'fast-glob';
 import {PnpmVersioning} from './pnpm-versioning.js';
+import {Commit} from '../../utils/git/octokit-types.js';
 
 /** Interface describing a Github repository. */
 export interface GithubRepo {
@@ -150,11 +151,11 @@ export abstract class ReleaseAction {
   }
 
   /** Gets the most recent commit of a specified branch. */
-  protected async getLatestCommitOfBranch(branchName: string): Promise<string> {
+  protected async getLatestCommitOfBranch(branchName: string): Promise<Commit> {
     const {
       data: {commit},
     } = await this.git.github.repos.getBranch({...this.git.remoteParams, branch: branchName});
-    return commit.sha;
+    return commit;
   }
 
   /** Checks whether the given revision is ahead to the base by the specified amount. */
@@ -560,7 +561,7 @@ export abstract class ReleaseAction {
     // Keep track of the commit where we started the staging process on. This will be used
     // later to ensure that no changes, except for the version bump have landed as part
     // of the staging time window (where the caretaker could accidentally land other stuff).
-    const beforeStagingSha = await this.getLatestCommitOfBranch(stagingBranch);
+    const {sha: beforeStagingSha} = await this.getLatestCommitOfBranch(stagingBranch);
 
     await this.assertPassingGithubStatus(beforeStagingSha, stagingBranch);
     await this.checkoutUpstreamBranch(stagingBranch);
@@ -703,7 +704,7 @@ export abstract class ReleaseAction {
     npmDistTag: NpmDistTag,
     additionalOptions: {showAsLatestOnGitHub: boolean},
   ) {
-    const versionBumpCommitSha = await this.getLatestCommitOfBranch(publishBranch);
+    const {sha: versionBumpCommitSha} = await this.getLatestCommitOfBranch(publishBranch);
 
     // Ensure the latest commit in the publish branch is the bump commit.
     if (!(await this._isCommitForVersionStaging(releaseNotes.version, versionBumpCommitSha))) {

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

@@ -33,7 +33,7 @@ export class ConfigureNextAsMajorAction extends ReleaseAction {
   override async perform() {
     const {branchName} = this.active.next;
     const newVersion = this._newVersion;
-    const beforeStagingSha = await this.getLatestCommitOfBranch(branchName);
+    const {sha: beforeStagingSha} = await this.getLatestCommitOfBranch(branchName);
 
     await this.assertPassingGithubStatus(beforeStagingSha, branchName);
     await this.checkoutUpstreamBranch(branchName);

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

@@ -39,7 +39,7 @@ export class PrepareExceptionalMinorAction extends ReleaseAction {
   }
 
   async perform(): Promise<void> {
-    const latestBaseBranchSha = await this.getLatestCommitOfBranch(this._baseBranch);
+    const {sha: latestBaseBranchSha} = await this.getLatestCommitOfBranch(this._baseBranch);
 
     await this.assertPassingGithubStatus(latestBaseBranchSha, this._baseBranch);
 

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

@@ -59,7 +59,7 @@ export abstract class BranchOffNextBranchBaseAction extends CutNpmNextPrerelease
     const compareVersionForReleaseNotes = await this._computeReleaseNoteCompareVersion();
     const newVersion = await this._computeNewVersion();
     const newBranch = `${newVersion.major}.${newVersion.minor}.x`;
-    const beforeStagingSha = await this.getLatestCommitOfBranch(nextBranchName);
+    const {sha: beforeStagingSha} = await this.getLatestCommitOfBranch(nextBranchName);
 
     // Verify the current next branch has a passing status, before we branch off.
     await this.assertPassingGithubStatus(beforeStagingSha, nextBranchName);

ng-dev/utils/BUILD.bazel

@@ -48,6 +48,7 @@ ts_library(
         "@npm//@octokit/auth-app",
         "@npm//@octokit/core",
         "@npm//@octokit/graphql",
+        "@npm//@octokit/openapi-types",
         "@npm//@octokit/plugin-paginate-rest",
         "@npm//@octokit/plugin-rest-endpoint-methods",
         "@npm//@octokit/request-error",

ng-dev/utils/git/octokit-types.ts

@@ -0,0 +1,3 @@
+import {components} from '@octokit/openapi-types';
+
+export type Commit = components['schemas']['commit'];