mikepenz/release-changelog-builder-actionPublic

NotificationsYou must be signed in to change notification settings
Fork114
Star812

Add path filtering support for monorepo setups#1458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

mikepenz merged 16 commits intodevelopfromcopilot/fix-1457

Aug 17, 2025

Merged

Add path filtering support for monorepo setups#1458

mikepenz merged 16 commits intodevelopfromcopilot/fix-1457

Aug 17, 2025

Conversation

Copy link

Contributor

CopilotAI commentedJul 4, 2025•
edited
Loading

This PR adds the ability to filter commits by file paths, enabling better changelog generation for monorepo setups where different applications are stored in separate directories.

Problem

In monorepo environments, users often want to generate changelogs that only include commits affecting specific parts of the codebase. For example, when deployingapp2, they don't want to see commits that only touched files inapp1/. The GitHub API's compare endpoint doesn't support path filtering likegit log -- app1/ does.

Solution

Added a new optional input parameterincludeOnlyPaths that accepts comma-separated path patterns:

-name:"App1 Changelog"uses:mikepenz/release-changelog-builder-action@{latest-release}with:includeOnlyPaths:"app1/,shared/"fromTag:"v1.0.0"toTag:"v2.0.0"

Implementation Details

GitHub API approach: For each commit, fetches file changes via additional API calls and filters commits based on whether any changed file matches the specified path patterns
Gitea approach: Usesgit log -- <paths> to filter commits directly by path using local git commands
Path matching: UsesstartsWith() for flexible prefix matching (e.g.,app1/ matchesapp1/src/file.js)
Backward compatible: Optional parameter that doesn't affect existing functionality

Changes Made

AddedincludeOnlyPaths input parameter toaction.yml
Updated input processing inmain.ts and parameter passing through the call chain
ExtendedOptions interface and repository classes to support path filtering
Added path filtering logic to bothGithubRepository andGiteaRepository
Added comprehensive tests for the new functionality
Updated README with usage examples and documentation

Testing

Added unit tests covering:

Path pattern parsing (comma-separated, whitespace handling)
Integration with existing commit filtering
Edge cases (empty paths, malformed input)

Existing tests continue to pass, ensuring backward compatibility.

Fixes#1457.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

gitea.com
- Triggering command:/usr/local/bin/node /home/REDACTED/work/release-changelog-builder-action/release-changelog-builder-action/node_modules/jest-worker/build/workers/processChild.js (dns block)
https://api.github.com/graphql
- Triggering command:/usr/local/bin/node /home/REDACTED/work/release-changelog-builder-action/release-changelog-builder-action/node_modules/jest-worker/build/workers/processChild.js (http block)
https://api.github.com/repos/mikepenz/release-changelog-builder-action-playground/compare/1.5.0...2.0.0
- Triggering command:/usr/local/bin/node /home/REDACTED/work/release-changelog-builder-action/release-changelog-builder-action/node_modules/jest-worker/build/workers/processChild.js (http block)
https://api.github.com/repos/mikepenz/release-changelog-builder-action-playground/compare/2.0.0...3.0.0-a01
- Triggering command:/usr/local/bin/node /home/REDACTED/work/release-changelog-builder-action/release-changelog-builder-action/node_modules/jest-worker/build/workers/processChild.js (http block)
https://api.github.com/repos/mikepenz/release-changelog-builder-action-playground/compare/2.0.0...3.0.1
- Triggering command:/usr/local/bin/node /home/REDACTED/work/release-changelog-builder-action/release-changelog-builder-action/node_modules/jest-worker/build/workers/processChild.js (http block)
https://api.github.com/repos/mikepenz/release-changelog-builder-action-playground/releases/tags/1.5.0
- Triggering command:/usr/local/bin/node /home/REDACTED/work/release-changelog-builder-action/release-changelog-builder-action/node_modules/jest-worker/build/workers/processChild.js (http block)
https://api.github.com/repos/mikepenz/release-changelog-builder-action-playground/releases/tags/2.0.0
- Triggering command:/usr/local/bin/node /home/REDACTED/work/release-changelog-builder-action/release-changelog-builder-action/node_modules/jest-worker/build/workers/processChild.js (http block)
https://api.github.com/repos/mikepenz/release-changelog-builder-action-playground/releases/tags/3.0.0-a01
- Triggering command:/usr/local/bin/node /home/REDACTED/work/release-changelog-builder-action/release-changelog-builder-action/node_modules/jest-worker/build/workers/processChild.js (http block)
https://api.github.com/repos/mikepenz/release-changelog-builder-action-playground/releases/tags/3.0.1
- Triggering command:/usr/local/bin/node /home/REDACTED/work/release-changelog-builder-action/release-changelog-builder-action/node_modules/jest-worker/build/workers/processChild.js (http block)

If you need me to access, download, or install something from one of these locations, you can either:

ConfigureActions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to myfirewall allow list

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Clickhere to start the survey.

CopilotAI assignedCopilot andmikepenz

Jul 4, 2025

Copilotstarted work on behalf ofmikepenz

July 4, 2025 11:18

View session

CopilotAI changed the title~~[WIP] Filtering commits by path~~Add path filtering support for monorepo setups

Jul 4, 2025

CopilotAI requested a review frommikepenz

July 4, 2025 11:37

Copilot finished work on behalf ofmikepenz

July 4, 2025 11:37

Copy link

caspervdw commentedJul 17, 2025

@mikepenz I tested this branch and it works as I would expect it to (using Github backend)

Copy link

Owner

mikepenz commentedAug 12, 2025

@copilot rebase please

Copilotstarted work on behalf ofmikepenz

August 12, 2025 05:15

View session

Copy link

ContributorAuthor

CopilotAI commentedAug 12, 2025

@copilot rebase please

I'm unable to perform git rebase operations as I don't have access to git push/rebase commands in this environment. You'll need to rebase this branch manually or through the GitHub interface.

Copilot finished work on behalf ofmikepenz

August 12, 2025 05:17

mikepenz force-pushed thecopilot/fix-1457 branch from9660bbc toe9894edCompare

August 12, 2025 05:21

Copy link

github-actionsbot commentedAug 12, 2025•
edited
Loading

	Tests	Passed ✅	Skipped	Failed
JUnit Test Report	67 ran	67 passed	0 skipped	0 failed

Test	Result
No test annotations available

View JUnit Test Report

mikepenz force-pushed thecopilot/fix-1457 branch frome9894ed toa3d6e36Compare

August 12, 2025 05:36

mikepenz requested a review fromCopilot

August 12, 2025 05:36

This comment was marked as outdated.

mikepenz force-pushed thecopilot/fix-1457 branch fromcb0a5a9 toe65be06Compare

August 12, 2025 09:43

mikepenz marked this pull request as ready for review

August 16, 2025 10:05

CopilotAIand others added10 commits

August 16, 2025 14:13

Initial plan

b61a380

Implement path filtering for commits in monorepo setups

26910c6

Co-authored-by: mikepenz <1476232+mikepenz@users.noreply.github.com>

- recompile dist

2dce5d0

update: enhance includeOnlyPaths handling, change to multiline input …

649dd07

…& adjust type accordingly

- warn that usingincludeOnlyPaths will use extra api requests

ba0609a

feat: improve includeOnlyPaths support across various repository impl…

d60f04a

…ementations- Refactored `includeOnlyPaths` handling for better consistency.- Added path filtering to `getDiffStats` and `getCommitsBetween` functions.- Updated tests to reflect changes in path filtering logic.- Enhanced offline and remote repository handling with path filtering support.

feat: optimize and simplify includeOnlyPaths processing in GithubRepo…

ba51b40

…sitory- Refactored path filtering logic for better efficiency and readability.- Consolidated file matching and commit filtering to reduce redundant API calls.- Improved handling of commit-to-file mapping.- Adjusted logic to streamline stats collection and filtering process.

recompile dist

6c9dfe2

refactor: remove unused changedFiles property from commit objects

14c7858

test: use fake timers and adjust test timeout in transform tests

f1f0303

mikepenz force-pushed thecopilot/fix-1457 branch from48da528 tof1f0303Compare

August 16, 2025 12:14

- fix formatting

32e46ee

- remove jest

595d50d

mikepenz added the feature label

Aug 16, 2025

mikepenz requested a review fromCopilot

August 16, 2025 12:20

This comment was marked as outdated.

mikepenz added4 commits

August 16, 2025 14:21

- fixed extra requests

3b23ec1

adjust file to commit mapping

13f263a

simplify by using a set, remove obsolete handling

0ccf865

- fix filtering based on file path for github when doing it remotely

4a8e4e9

mikepenz requested a review fromCopilot

August 17, 2025 10:39

CopilotAI reviewed

Aug 17, 2025

View reviewed changes

Copy link

CopilotAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Pull Request Overview

This PR adds support for path filtering in monorepo environments by introducing anincludeOnlyPaths parameter that allows filtering commits based on the files they modify. This enables users to generate changelogs that only include commits affecting specific parts of their codebase.

AddedincludeOnlyPaths input parameter to filter commits by file paths
Updated repository implementations to support path filtering with different strategies for GitHub and Gitea
Added comprehensive test coverage for the new functionality

Reviewed Changes

Copilot reviewed 12 out of 14 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
action.yml	Added`includeOnlyPaths` input parameter definition
src/main.ts	Added input processing for path patterns with filtering logic
src/repositories/*.ts	Updated all repository classes to support path filtering parameter
src/pr-collector/*.ts	Updated data flow to pass path filtering through the collection pipeline
tests/pathFiltering.test.ts	Added unit tests for path filtering functionality
README.md	Added documentation and usage examples for monorepo configuration

_{Tip: Customize your code reviews with copilot-instructions.md.Create the file orlearn how to get started.}

src/repositories/GiteaRepository.ts

		authorName:commit.authorName,
		authorDate:moment(commit.authorDate),
		committer:"",
		committerName:"",

Copy link

CopilotAIAug 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

The committer field is hardcoded to an empty string instead of using the actual commit data. This loses information that was previously available in the original implementation.

Suggested change

	committerName:"",
	committer:commit.committer??"",
	committerName:commit.committerName??"",

Copilot uses AI. Check for mistakes.

src/repositories/GiteaRepository.ts

		authorName:commit.authorName,
		authorDate:moment(commit.authorDate),
		committer:"",
		committerName:"",

Copy link

CopilotAIAug 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

The committerName field is hardcoded to an empty string instead of using the actual commit data. This loses information that was previously available in the original implementation.

Suggested change

	committerName:"",
	committer:commit.committer,
	committerName:commit.committerName,

Copilot uses AI. Check for mistakes.

src/repositories/GithubRepository.ts

		letchangeCount=0
		letcommitCount=0

		constpathFilteringEnabled=(includeOnlyPaths&&includeOnlyPaths.length>0)==true

Copy link

CopilotAIAug 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Using== true is redundant. The expression(includeOnlyPaths && includeOnlyPaths.length > 0) already returns a boolean.

Suggested change

	constpathFilteringEnabled=(includeOnlyPaths&&includeOnlyPaths.length>0)==true
	constpathFilteringEnabled=(includeOnlyPaths&&includeOnlyPaths.length>0)

Copilot uses AI. Check for mistakes.

src/repositories/GithubRepository.ts

		commitInfo:commits
		commits:filteredCommits.length,
		commitInfo:filteredCommits
		.filter(commit=>commit.sha)

Copy link

CopilotAIAug 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

[nitpick] The filter operationcommit => commit.sha is applied after path filtering, butcommit.sha should always be present in GitHub API responses. This filter may be unnecessary or could indicate a deeper issue.

Suggested change

.filter(commit => commit.sha)

Copilot uses AI. Check for mistakes.

mikepenz merged commit3429301 intodevelop

Aug 17, 2025

7 checks passed

mikepenz deleted the copilot/fix-1457 branch

August 17, 2025 11:09

Labels

feature

Movatterモバイル変換

Uh oh!

Add path filtering support for monorepo setups#1458

Add path filtering support for monorepo setups#1458

Uh oh!

Conversation

CopilotAI commentedJul 4, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Problem

Solution

Implementation Details

Changes Made

Testing

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

caspervdw commentedJul 17, 2025

Uh oh!

mikepenz commentedAug 12, 2025

Uh oh!

CopilotAI commentedAug 12, 2025

Uh oh!

github-actionsbot commentedAug 12, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

CopilotAIAug 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIAug 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIAug 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIAug 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CopilotAI commentedJul 4, 2025•
edited
Loading

github-actionsbot commentedAug 12, 2025•
edited
Loading