feat: allow configuring separate-pull-requests per component (#1412)

* test: add failing test for separating individual components in manifest

* feat: allow configuring separate-pull-requests per component

* test: add failing test for includeComponentInTag

* fix: use the component in the branch name

* declare generic types

Author: chingor13

src/manifest.ts

@@ -76,6 +76,7 @@ export interface ReleaserConfig {
   includeVInTag?: boolean;
   pullRequestTitlePattern?: string;
   tagSeparator?: string;
+  separatePullRequests?: boolean;
 
   // Changelog options
   changelogSections?: ChangelogSection[];
@@ -120,6 +121,7 @@ interface ReleaserConfigJson {
   'changelog-type'?: ChangelogNotesType;
   'changelog-host'?: string;
   'pull-request-title-pattern'?: string;
+  'separate-pull-requests'?: boolean;
   'tag-separator'?: string;
   'extra-files'?: string[];
   'version-file'?: string;
@@ -177,7 +179,6 @@ export interface ManifestConfig extends ReleaserConfigJson {
   'last-release-sha'?: string;
   'always-link-local'?: boolean;
   plugins?: PluginType[];
-  'separate-pull-requests'?: boolean;
   'group-pull-request-title-pattern'?: string;
   'release-search-depth'?: number;
   'commit-search-depth'?: number;
@@ -1140,6 +1141,7 @@ function extractReleaserConfig(
     changelogType: config['changelog-type'],
     pullRequestTitlePattern: config['pull-request-title-pattern'],
     tagSeparator: config['tag-separator'],
+    separatePullRequests: config['separate-pull-requests'],
   };
 }
 
@@ -1386,6 +1388,8 @@ function mergeReleaserConfig(
     pullRequestTitlePattern:
       pathConfig.pullRequestTitlePattern ??
       defaultConfig.pullRequestTitlePattern,
+    separatePullRequests:
+      pathConfig.separatePullRequests ?? defaultConfig.separatePullRequests,
   };
 }
 

src/plugins/merge.ts

@@ -55,11 +55,25 @@ export class Merge extends ManifestPlugin {
     }
     logger.info(`Merging ${candidates.length} pull requests`);
 
+    const [inScopeCandidates, outOfScopeCandidates] = candidates.reduce<
+      Array<Array<CandidateReleasePullRequest>>
+    >(
+      (collection, candidate) => {
+        if (candidate.config.separatePullRequests) {
+          collection[1].push(candidate);
+        } else {
+          collection[0].push(candidate);
+        }
+        return collection;
+      },
+      [[], []]
+    );
+
     const releaseData: ReleaseData[] = [];
     const labels = new Set<string>();
     let rawUpdates: Update[] = [];
     let rootRelease: CandidateReleasePullRequest | null = null;
-    for (const candidate of candidates) {
+    for (const candidate of inScopeCandidates) {
       const pullRequest = candidate.pullRequest;
       rawUpdates = rawUpdates.concat(...pullRequest.updates);
       for (const label of pullRequest.labels) {
@@ -99,6 +113,7 @@ export class Merge extends ManifestPlugin {
           releaseType,
         },
       },
+      ...outOfScopeCandidates,
     ];
   }
 }

src/strategies/base.ts

@@ -152,6 +152,10 @@ export abstract class BaseStrategy implements Strategy {
     );
   }
 
+  protected async getBranchComponent(): Promise<string | undefined> {
+    return this.component || (await this.getDefaultComponent());
+  }
+
   async getPackageName(): Promise<string | undefined> {
     return this.packageName ?? (await this.getDefaultPackageName());
   }
@@ -265,8 +269,9 @@ export abstract class BaseStrategy implements Strategy {
       newVersion,
       this.pullRequestTitlePattern
     );
-    const branchName = component
-      ? BranchName.ofComponentTargetBranch(component, this.targetBranch)
+    const branchComponent = await this.getBranchComponent();
+    const branchName = branchComponent
+      ? BranchName.ofComponentTargetBranch(branchComponent, this.targetBranch)
       : BranchName.ofTargetBranch(this.targetBranch);
     const releaseNotesBody = await this.buildReleaseNotes(
       conventionalCommits,

test/manifest.ts

@@ -554,6 +554,38 @@ describe('Manifest', () => {
       expect(manifest.releaseSearchDepth).to.eql(10);
       expect(manifest.commitSearchDepth).to.eql(50);
     });
+
+    it('should read changelog host from manifest', async () => {
+      const getFileContentsStub = sandbox.stub(
+        github,
+        'getFileContentsOnBranch'
+      );
+      getFileContentsStub
+        .withArgs('release-please-config.json', 'main')
+        .resolves(
+          buildGitHubFileContent(
+            fixturesPath,
+            'manifest/config/changelog-host.json'
+          )
+        )
+        .withArgs('.release-please-manifest.json', 'main')
+        .resolves(
+          buildGitHubFileContent(
+            fixturesPath,
+            'manifest/versions/versions.json'
+          )
+        );
+      const manifest = await Manifest.fromManifest(
+        github,
+        github.repository.defaultBranch
+      );
+      expect(manifest.repositoryConfig['.'].changelogHost).to.eql(
+        'https://example.com'
+      );
+      expect(
+        manifest.repositoryConfig['packages/bot-config-utils'].changelogHost
+      ).to.eql('https://override.example.com');
+    });
   });
 
   describe('fromConfig', () => {
@@ -2725,36 +2757,176 @@ describe('Manifest', () => {
       );
     });
 
-    it('should read changelog host from manifest', async () => {
-      const getFileContentsStub = sandbox.stub(
-        github,
-        'getFileContentsOnBranch'
-      );
-      getFileContentsStub
-        .withArgs('release-please-config.json', 'main')
-        .resolves(
-          buildGitHubFileContent(
-            fixturesPath,
-            'manifest/config/changelog-host.json'
-          )
-        )
-        .withArgs('.release-please-manifest.json', 'main')
-        .resolves(
-          buildGitHubFileContent(
-            fixturesPath,
-            'manifest/versions/versions.json'
-          )
+    describe('with multiple components', () => {
+      beforeEach(() => {
+        mockReleases(sandbox, github, []);
+        mockTags(sandbox, github, [
+          {
+            name: 'b-v1.0.0',
+            sha: 'abc123',
+          },
+          {
+            name: 'c-v2.0.0',
+            sha: 'abc123',
+          },
+          {
+            name: 'd-v3.0.0',
+            sha: 'abc123',
+          },
+        ]);
+        mockCommits(sandbox, github, [
+          {
+            sha: 'def456',
+            message: 'fix: some bugfix',
+            files: ['pkg/b/foo.txt', 'pkg/c/foo.txt', 'pkg/d/foo.txt'],
+          },
+          {
+            sha: 'abc123',
+            message: 'chore: release main',
+            files: [],
+            pullRequest: {
+              headBranchName: 'release-please/branches/main/components/pkg1',
+              baseBranchName: 'main',
+              number: 123,
+              title: 'chore: release main',
+              body: '',
+              labels: [],
+              files: [],
+              sha: 'abc123',
+            },
+          },
+        ]);
+        const getFileContentsStub = sandbox.stub(
+          github,
+          'getFileContentsOnBranch'
         );
-      const manifest = await Manifest.fromManifest(
-        github,
-        github.repository.defaultBranch
-      );
-      expect(manifest.repositoryConfig['.'].changelogHost).to.eql(
-        'https://example.com'
-      );
-      expect(
-        manifest.repositoryConfig['packages/bot-config-utils'].changelogHost
-      ).to.eql('https://override.example.com');
+        getFileContentsStub
+          .withArgs('package.json', 'main')
+          .resolves(
+            buildGitHubFileContent(
+              fixturesPath,
+              'manifest/repo/node/pkg1/package.json'
+            )
+          );
+      });
+
+      it('should allow configuring separate pull requests', async () => {
+        const manifest = new Manifest(
+          github,
+          'main',
+          {
+            'pkg/b': {
+              releaseType: 'simple',
+              component: 'b',
+            },
+            'pkg/c': {
+              releaseType: 'simple',
+              component: 'c',
+            },
+            'pkg/d': {
+              releaseType: 'simple',
+              component: 'd',
+            },
+          },
+          {
+            'pkg/b': Version.parse('1.0.0'),
+            'pkg/c': Version.parse('2.0.0'),
+            'pkg/d': Version.parse('3.0.0'),
+          },
+          {
+            separatePullRequests: true,
+          }
+        );
+        const pullRequests = await manifest.buildPullRequests();
+        expect(pullRequests).lengthOf(3);
+        const pullRequestB = pullRequests[0];
+        expect(pullRequestB.headRefName).to.eql(
+          'release-please--branches--main--components--b'
+        );
+        const pullRequestC = pullRequests[1];
+        expect(pullRequestC.headRefName).to.eql(
+          'release-please--branches--main--components--c'
+        );
+        const pullRequestD = pullRequests[2];
+        expect(pullRequestD.headRefName).to.eql(
+          'release-please--branches--main--components--d'
+        );
+      });
+
+      it('should allow configuring individual separate pull requests', async () => {
+        const manifest = new Manifest(
+          github,
+          'main',
+          {
+            'pkg/b': {
+              releaseType: 'simple',
+              component: 'b',
+            },
+            'pkg/c': {
+              releaseType: 'simple',
+              component: 'c',
+            },
+            'pkg/d': {
+              releaseType: 'simple',
+              component: 'd',
+              separatePullRequests: true,
+            },
+          },
+          {
+            'pkg/b': Version.parse('1.0.0'),
+            'pkg/c': Version.parse('2.0.0'),
+            'pkg/d': Version.parse('3.0.0'),
+          }
+        );
+        const pullRequests = await manifest.buildPullRequests();
+        expect(pullRequests).lengthOf(2);
+        const pullRequest = pullRequests[0];
+        expect(pullRequest.headRefName).to.eql(
+          'release-please--branches--main'
+        );
+        const mainPullRequest = pullRequests[1];
+        expect(mainPullRequest.headRefName).to.eql(
+          'release-please--branches--main--components--d'
+        );
+      });
+
+      it('should allow configuring individual separate pull requests with includeComponentInTag = false', async () => {
+        const manifest = new Manifest(
+          github,
+          'main',
+          {
+            'pkg/b': {
+              releaseType: 'simple',
+              component: 'b',
+            },
+            'pkg/c': {
+              releaseType: 'simple',
+              component: 'c',
+            },
+            'pkg/d': {
+              releaseType: 'simple',
+              component: 'd',
+              separatePullRequests: true,
+              includeComponentInTag: false,
+            },
+          },
+          {
+            'pkg/b': Version.parse('1.0.0'),
+            'pkg/c': Version.parse('2.0.0'),
+            'pkg/d': Version.parse('3.0.0'),
+          }
+        );
+        const pullRequests = await manifest.buildPullRequests();
+        expect(pullRequests).lengthOf(2);
+        const pullRequest = pullRequests[0];
+        expect(pullRequest.headRefName).to.eql(
+          'release-please--branches--main'
+        );
+        const mainPullRequest = pullRequests[1];
+        expect(mainPullRequest.headRefName).to.eql(
+          'release-please--branches--main--components--d'
+        );
+      });
     });
   });