fix: merge updates when creating a changeset (#2601)

suztomo · web-flow · commit 320884894f59 · 2025-10-06T11:51:33.000-07:00
* fix: merge updates when creating a change set

The node-workspace plugin's manifest file update was overwriting
the default change made in manifest.ts with no changes.

b/444669596
diff --git a/src/github.ts b/src/github.ts
@@ -50,6 +50,7 @@ import {Logger} from 'code-suggester/build/src/types';
 import {HttpsProxyAgent} from 'https-proxy-agent';
 import {HttpProxyAgent} from 'http-proxy-agent';
 import {PullRequestOverflowHandler} from './util/pull-request-overflow-handler';
+import {mergeUpdates} from './updaters/composite';
 
 // Extract some types from the `request` package.
 type RequestBuilderType = typeof request;
@@ -1287,8 +1288,12 @@ export class GitHub {
     updates: Update[],
     defaultBranch: string
   ): Promise<ChangeSet> {
+    // Sometimes multiple updates are proposed for the same file,
+    // such as when the manifest file is additionally changed by the
+    // node-workspace plugin. We need to merge these updates.
+    const mergedUpdates = mergeUpdates(updates);
     const changes = new Map();
-    for (const update of updates) {
+    for (const update of mergedUpdates) {
       let content: GitHubFileContents | undefined;
       try {
         content = await this.getFileContentsOnBranch(
diff --git a/test/github.ts b/test/github.ts
@@ -37,6 +37,7 @@ import {PullRequestBody} from '../src/util/pull-request-body';
 import {PullRequestTitle} from '../src/util/pull-request-title';
 import * as codeSuggester from 'code-suggester';
 import {RawContent} from '../src/updaters/raw-content';
+import {ReleasePleaseManifest} from '../src/updaters/release-please-manifest';
 import {HttpsProxyAgent} from 'https-proxy-agent';
 import {HttpProxyAgent} from 'http-proxy-agent';
 import {Commit} from '../src/commit';
@@ -1062,6 +1063,64 @@ describe('GitHub', () => {
     });
   });
 
+  describe('buildChangeSet', () => {
+    it('should merge updates for the same file', async () => {
+      const manifestPath = '.release-please-manifest.json';
+      const initialContent = JSON.stringify(
+        {
+          path1: '1.0.0',
+          path2: '2.0.0',
+        },
+        null,
+        2
+      );
+      sandbox
+        .stub(github, 'getFileContentsOnBranch')
+        .withArgs(manifestPath, 'main')
+        .resolves({
+          sha: 'abc123',
+          content: Buffer.from(initialContent).toString('base64'),
+          parsedContent: initialContent,
+          mode: '100644',
+        });
+
+      const updates = [
+        {
+          path: manifestPath,
+          createIfMissing: false,
+          updater: new ReleasePleaseManifest({
+            version: Version.parse('1.1.0'),
+            versionsMap: new Map([['path1', Version.parse('1.1.0')]]),
+          }),
+        },
+        {
+          path: manifestPath,
+          createIfMissing: false,
+          updater: new ReleasePleaseManifest({
+            version: Version.parse('1.1.0'),
+            versionsMap: new Map(),
+          }),
+        },
+      ];
+
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const changes = await (github as any).buildChangeSet(updates, 'main');
+
+      expect(changes).to.not.be.undefined;
+      expect(changes!.size).to.eql(1);
+      const updatedContent = changes!.get(manifestPath)!.content;
+      const expectedContent = JSON.stringify(
+        {
+          path1: '1.1.0',
+          path2: '2.0.0',
+        },
+        null,
+        2
+      );
+      expect(updatedContent).to.eql(expectedContent);
+    });
+  });
+
   describe('createFileOnNewBranch', () => {
     it('forks a new branch if the branch does not exist', async () => {
       req = req
