feat: allow specifying components by Component commit footer

src/util/commit-split.ts

@@ -71,7 +71,9 @@ export class CommitSplit {
    * with a set of tracked package paths, then only consider paths for
    * configured components. If `includeEmpty` is configured, then a commit
    * that does not touch any files will be applied to all components'
-   * commits.
+   * commits. If a commit contains `Component: ...` footer(s), it will be
+   * included in those components as well any package paths it touches.
+   *
    * @param {Commit[]} commits The commits to split
    * @returns {Record<string, Commit[]>} Commits indexed by component path
    */
@@ -106,6 +108,7 @@ export class CommitSplit {
         if (!splitCommits[pkgName]) splitCommits[pkgName] = [];
         splitCommits[pkgName].push(commit);
       }
+      // todo: handle 'Component: ...' commit footers
       if (commit.files.length === 0 && this.includeEmpty) {
         if (this.packagePaths) {
           for (const pkgName of this.packagePaths) {

test/manifest.ts

@@ -1814,6 +1814,109 @@ describe('Manifest', () => {
       snapshot(dateSafe(pullRequests[0].body.toString()));
     });
 
+    it('should handle multiple package repository with Component commit footers', async () => {
+      mockReleases(sandbox, github, [
+        {
+          id: 123456,
+          sha: 'abc123',
+          tagName: 'pkg1-v1.0.0',
+          url: 'https://github.com/fake-owner/fake-repo/releases/tag/pkg1-v1.0.0',
+        },
+        {
+          id: 654321,
+          sha: 'def234',
+          tagName: 'pkg2-v0.2.3',
+          url: 'https://github.com/fake-owner/fake-repo/releases/tag/pkg2-v0.2.3',
+        },
+        {
+          id: 987654,
+          sha: 'def234',
+          tagName: 'pkg3-v0.1.2',
+          url: 'https://github.com/fake-owner/fake-repo/releases/tag/pkg3-v0.1.2',
+        },
+      ]);
+      mockCommits(sandbox, github, [
+        {
+          sha: 'aaaaaa',
+          message: 'fix: some bugfix',
+          files: ['path/a/foo'],
+        },
+        {
+          sha: 'abc123',
+          message: 'chore: release main',
+          files: [],
+          pullRequest: {
+            headBranchName: 'release-please/branches/main',
+            baseBranchName: 'main',
+            number: 123,
+            title: 'chore: release main',
+            body: '',
+            labels: [],
+            files: [],
+            sha: 'abc123',
+          },
+        },
+        {
+          sha: 'bbbbbb',
+          message: 'fix: some bugfix',
+          files: ['path/b/foo'],
+        },
+        {
+          sha: 'cccccc',
+          message: 'fix: some bugfix',
+          files: ['path/a/foo'],
+        },
+        {
+          sha: 'dddddd',
+          message:
+            'chore(pkg3): transition to beta\n\nComponent: pkg3\nRelease-As: 0.1.2-beta',
+          files: [],
+        },
+        {
+          sha: 'def234',
+          message: 'chore: release main',
+          files: [],
+          pullRequest: {
+            headBranchName: 'release-please/branches/main',
+            baseBranchName: 'main',
+            number: 123,
+            title: 'chore: release main',
+            body: '',
+            labels: [],
+            files: [],
+            sha: 'def234',
+          },
+        },
+      ]);
+      const manifest = new Manifest(
+        github,
+        'main',
+        {
+          'path/a': {
+            releaseType: 'simple',
+            component: 'pkg1',
+          },
+          'path/b': {
+            releaseType: 'simple',
+            component: 'pkg2',
+          },
+          'path/c': {
+            releaseType: 'simple',
+            component: 'pkg3',
+          },
+        },
+        {
+          'path/a': Version.parse('1.0.0'),
+          'path/b': Version.parse('0.2.3'),
+          'path/c': Version.parse('0.1.2'),
+        }
+      );
+      const pullRequests = await manifest.buildPullRequests();
+      expect(pullRequests).lengthOf(1);
+      expect(pullRequests[0].labels).to.eql(['autorelease: pending']);
+      snapshot(dateSafe(pullRequests[0].body.toString()));
+    });
+
     it('should allow creating multiple pull requests', async () => {
       mockReleases(sandbox, github, [
         {

test/util/commit-split.ts

@@ -98,8 +98,50 @@ describe('CommitSplit', () => {
       expect(splitCommits['pkg3']).to.be.undefined;
       expect(splitCommits['pkg4']).lengthOf(1);
     });
+    it('should separate commits by Component footer', () => {
+      const commitSplit = new CommitSplit({includeEmpty: true});
+      const splitCommits = commitSplit.split([
+        ...commits,
+        {
+          sha: 'klm',
+          message: 'commit klm\n\nComponent: pkg1',
+          files: ['pkg2/baz.txt'],
+        },
+        {sha: 'nop', message: 'commit nop\n\nComponent: pkg4', files: []},
+      ]);
+      expect(splitCommits['pkg1']).lengthOf(
+        4 /* commits: abc123, def234, efg, klm */
+      );
+      expect(splitCommits['pkg1'][3].sha).to.eql('klm');
+      expect(splitCommits['pkg2']).lengthOf(2); /* commits: abc123, klm */
+      expect(splitCommits['pkg3']).lengthOf(2); /* commits: def234, efg */
+      expect(splitCommits['pkg4']).lengthOf(1); /* commits: nop */
+      expect(splitCommits['pkg4'][0].sha).to.eql('nop');
+    });
+    it('should separate commits by Component footer with limited list of paths', () => {
+      const commitSplit = new CommitSplit({
+        includeEmpty: true,
+        packagePaths: ['pkg1', 'pkg4'],
+      });
+      const splitCommits = commitSplit.split([
+        ...commits,
+        {
+          sha: 'klm',
+          message: 'commit klm\n\nComponent: pkg1',
+          files: ['pkg2/baz.txt'],
+        },
+        {sha: 'nop', message: 'commit nop\n\nComponent: pkg4', files: []},
+      ]);
+      expect(splitCommits['pkg1']).lengthOf(
+        4 /* commits: abc123, def234, efg, klm */
+      );
+      expect(splitCommits['pkg1'][3].sha).to.eql('klm');
+      expect(splitCommits['pkg2']).to.be.undefined;
+      expect(splitCommits['pkg3']).to.be.undefined;
+      expect(splitCommits['pkg4']).lengthOf(1); /* commits: nop */
+      expect(splitCommits['pkg4'][0].sha).to.eql('nop');
+    });
   });
-
   describe('excluding empty commits', () => {
     it('should separate commits', () => {
       const commitSplit = new CommitSplit({
@@ -122,5 +164,48 @@ describe('CommitSplit', () => {
       expect(splitCommits['pkg3']).to.be.undefined;
       expect(splitCommits['pkg4']).to.be.undefined;
     });
+    it('should separate commits by Component footer', () => {
+      const commitSplit = new CommitSplit({includeEmpty: false});
+      const splitCommits = commitSplit.split([
+        ...commits,
+        {
+          sha: 'klm',
+          message: 'commit klm\n\nComponent: pkg1',
+          files: ['pkg2/baz.txt'],
+        },
+        {sha: 'nop', message: 'commit nop\n\nComponent: pkg4', files: []},
+      ]);
+      expect(splitCommits['pkg1']).lengthOf(
+        3 /* commits: abc123, def234, klm */
+      );
+      expect(splitCommits['pkg1'][2].sha).to.eql('klm');
+      expect(splitCommits['pkg2']).lengthOf(2); /* commits: abc123, klm */
+      expect(splitCommits['pkg3']).lengthOf(1); /* commits: def234, efg */
+      expect(splitCommits['pkg4']).lengthOf(1); /* commits: nop */
+      expect(splitCommits['pkg4'][0].sha).to.eql('nop');
+    });
+    it('should separate commits by Component footer with limited list of paths', () => {
+      const commitSplit = new CommitSplit({
+        includeEmpty: false,
+        packagePaths: ['pkg1', 'pkg4'],
+      });
+      const splitCommits = commitSplit.split([
+        ...commits,
+        {
+          sha: 'klm',
+          message: 'commit klm\n\nComponent: pkg1',
+          files: ['pkg2/baz.txt'],
+        },
+        {sha: 'nop', message: 'commit nop\n\nComponent: pkg4', files: []},
+      ]);
+      expect(splitCommits['pkg1']).lengthOf(
+        3 /* commits: abc123, def234, klm */
+      );
+      expect(splitCommits['pkg1'][2].sha).to.eql('klm');
+      expect(splitCommits['pkg2']).to.be.undefined;
+      expect(splitCommits['pkg3']).to.be.undefined;
+      expect(splitCommits['pkg4']).lengthOf(1); /* commits: nop */
+      expect(splitCommits['pkg4'][0].sha).to.eql('nop');
+    });
   });
 });