fix: prevent open release PRs from being mistaken as current releases (…

…#2323) * docs: add compile step to local run command * fix: prevent open release PRs from being mistaken as current releases --------- Co-authored-by: Jeff Ching <chingor@google.com>
googleapis · Sep 11, 2024 · 3101ab3 · 3101ab3
1 parent 92abffb
commit 3101ab3
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -62,7 +62,7 @@ accept your pull requests.
    The below command should be run from the root of the source code:
 
    ```
-   node build/src/bin/release-please.js release-pr \
+   npm run compile && node build/src/bin/release-please.js release-pr \
    --token=$GITHUB_TOKEN \
    --repo-url=<owner>/<repo> [extra options]
    ```

diff --git a/__snapshots__/github.js b/__snapshots__/github.js
diff --git a/src/github.ts b/src/github.ts
@@ -510,6 +510,7 @@ export class GitHub {
           number: pullRequest.number,
           baseBranchName: pullRequest.baseRefName,
           headBranchName: pullRequest.headRefName,
+          mergeCommitOid: pullRequest.mergeCommit?.oid,
           title: pullRequest.title,
           body: pullRequest.body,
           labels: pullRequest.labels.nodes.map(node => node.name),

diff --git a/src/manifest.ts b/src/manifest.ts
@@ -1575,7 +1575,7 @@ async function latestReleaseVersion(
   for await (const commitWithPullRequest of generator) {
     commitShas.add(commitWithPullRequest.sha);
     const mergedPullRequest = commitWithPullRequest.pullRequest;
-    if (!mergedPullRequest) {
+    if (!mergedPullRequest?.mergeCommitOid) {
       logger.trace(
         `skipping commit: ${commitWithPullRequest.sha} missing merged pull request`
       );

diff --git a/src/pull-request.ts b/src/pull-request.ts
@@ -16,6 +16,7 @@ export interface PullRequest {
   readonly headBranchName: string;
   readonly baseBranchName: string;
   readonly number: number;
+  readonly mergeCommitOid?: string;
   readonly title: string;
   readonly body: string;
   readonly labels: string[];

diff --git a/test/manifest.ts b/test/manifest.ts
@@ -1423,6 +1423,7 @@ describe('Manifest', () => {
             title: 'chore: release 1.2.3',
             headBranchName: 'release-please/branches/main',
             baseBranchName: 'main',
+            mergeCommitOid: 'abc123',
             number: 123,
             body: '',
             labels: [],