Merge pull request #1458 from mikepenz/copilot/fix-1457

Add path filtering support for monorepo setups

Author: mikepenz

README.md

@@ -204,6 +204,28 @@ Depending on the use-case additional settings can be provided to the action
     token: ${{ secrets.PAT }}
 ```
 
+<details><summary><b>Monorepo Configuration</b></summary>
+<p>
+
+For **monorepo setups**, you can filter commits by path to generate changelogs only for specific components:
+
+```yml
+- name: "App1 Changelog"
+  id: build_app1_changelog
+  if: startsWith(github.ref, 'refs/tags/')
+  uses: mikepenz/release-changelog-builder-action@{latest-release}
+  with:
+    includeOnlyPaths: |
+      app1/
+      shared/
+    fromTag: "v1.0.0"
+    toTag: "v2.0.0"
+    token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+</p>
+</details>
+
 > [!NOTE]  
 > All input values are optional. It is only required to provide the `token` either via the input, or as `env` variable.
 
@@ -231,6 +253,7 @@ Depending on the use-case additional settings can be provided to the action
 | `exportCache`             | Will enable exporting the fetched PR information to a cache, which can be re-used by later runs. Default: false                                                                                                                                                                                                                                                                                                                                                                                                             |
 | `exportOnly`              | When enabled, will result in only exporting the cache, without generating a changelog. Default: false (Requires `exportCache` to be enabled)                                                                                                                                                                                                                                                                                                                                                                                |
 | `cache`                   | The file path to write/read the cache to/from.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| `includeOnlyPaths`        | List of path patterns to include. Provide as multiline input (one per line). Only commits that touched these paths will be included in the changelog. Useful for monorepo setups where you want to filter commits by their affected paths. GitHub (non-offline mode): when `includeOnlyPaths` is defined, the action performs an extra API call per commit to determine which files were modified by that commit. This can significantly increase API usage for large diffs.                                                |
 
 > [!WARNING]  
 > `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repositories please use a PAT (Personal Access Token).

__tests__/pathFiltering.test.ts

@@ -0,0 +1,50 @@
+import {CommitInfo, filterCommits} from '../src/pr-collector/commits.js'
+import moment from 'moment'
+import {expect, describe, test} from 'vitest'
+
+describe('Path Filtering', () => {
+  test('should filter commits by merge branches (existing functionality)', () => {
+    const commits: CommitInfo[] = [
+      {
+        sha: 'commit1',
+        summary: 'feat: add new feature',
+        message: 'feat: add new feature\n\nDetailed description',
+        author: 'user1',
+        authorName: 'User One',
+        authorDate: moment(),
+        committer: 'user1',
+        committerName: 'User One',
+        commitDate: moment()
+      },
+      {
+        sha: 'commit2',
+        summary: 'Merge pull request #123 from feature-branch',
+        message: 'Merge pull request #123 from feature-branch',
+        author: 'user2',
+        authorName: 'User Two',
+        authorDate: moment(),
+        committer: 'user2',
+        committerName: 'User Two',
+        commitDate: moment()
+      },
+      {
+        sha: 'commit3',
+        summary: 'fix: bug fix',
+        message: 'fix: bug fix',
+        author: 'user3',
+        authorName: 'User Three',
+        authorDate: moment(),
+        committer: 'user3',
+        committerName: 'User Three',
+        commitDate: moment()
+      }
+    ]
+
+    const excludeMergeBranches = ['Merge pull request']
+    const filtered = filterCommits(commits, excludeMergeBranches)
+
+    expect(filtered).toHaveLength(2)
+    expect(filtered[0].sha).toBe('commit1')
+    expect(filtered[1].sha).toBe('commit3')
+  })
+})

action.yml

@@ -66,6 +66,8 @@ inputs:
   platform:
     description: 'Defines the platform the action is run on. Available options: [`github`, `gitea`]. Defaults to `github`.'
     default: "github"
+  includeOnlyPaths:
+    description: 'List of path patterns to include. Provide as multiline input (one per line). Only commits that touched these paths will be included in the changelog. Useful for monorepo setups.'
 outputs:
   changelog:
     description: The built release changelog built from the merged pull requests