Skip to content

Parametrize Ignorable PR patterns in Changelog Generation #4

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
malkovro merged 1 commit into from
Jan 27, 2026
Merged

Parametrize Ignorable PR patterns in Changelog Generation #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions changelog/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@
MERGE_PR_RE = re.compile(r"^Merge pull request #([0-9]+) from .*\n\n(.*)")

# Merge commits of a release branch
MERGE_RELEASE_PR_RE = re.compile(
r"^Merge pull request #([0-9]+) from .*/release/.*\n\n(.*)"
)
MERGE_RELEASE_PR_RE = r"^Merge pull request #([0-9]+) from .*/release/.*\n\n(.*)"

# Squash-and-merge commits use the PR title with the number in parentheses
SQUASH_PR_RE = re.compile(r"^(.*) \(#([0-9]+)\).*")
Expand All @@ -42,6 +40,7 @@
"patch": 3,
"hotfix": 3,
"fix": 3,
"bug": 3,
"minor": 2,
"feature": 2,
"breaking": 1,
Expand Down Expand Up @@ -237,9 +236,9 @@ def is_pr(message):
return MERGE_PR_RE.search(message) or SQUASH_PR_RE.search(message)


def is_release_merge(message):
"""Determine whether or not a commit message is a release merge"""
return MERGE_RELEASE_PR_RE.search(message)
def matches_pattern(message, pattern):
"""Determine whether or not a commit message matches a pattern"""
return re.compile(pattern).search(message)


def extract_pr(message):
Expand All @@ -264,7 +263,7 @@ def fetch_changes(
previous_tag=None,
current_tag=None,
branch=DEFAULT_BRANCH,
ignore_release_merge=False,
ignore_pr_patterns=[MERGE_RELEASE_PR_RE],
):
if previous_tag is None:
previous_tag = get_last_tag(github_config, owner, repo)
Expand Down Expand Up @@ -293,8 +292,8 @@ def fetch_changes(

# First try to extract PR from commit message (merge/squash patterns)
if is_pr(commit.message):
# Skip release merges if ignore_release_merge is True
if ignore_release_merge and is_release_merge(commit.message):
# Skip release merges if ignore_pr_patterns is set
if ignore_pr_patterns and any(matches_pattern(commit.message, pattern) for pattern in ignore_pr_patterns):
continue
pr = extract_pr(commit.message)
else:
Expand Down Expand Up @@ -370,7 +369,7 @@ def generate_changelog(
github_base_url=None,
github_api_url=None,
github_token=None,
ignore_release_merge=False,
ignore_pr_patterns=[],
):
github_config = get_github_config(
github_base_url, github_api_url, github_token
Expand All @@ -383,7 +382,7 @@ def generate_changelog(
previous_tag,
current_tag,
branch,
ignore_release_merge,
ignore_pr_patterns,
)
lines = format_changes(github_config, owner, repo, prs, markdown=markdown)

Expand Down Expand Up @@ -457,9 +456,11 @@ def main():
)

parser.add_argument(
"--ignore-release-merge",
action="store_true",
help="Override if you don't want to add release merges on the changelog",
"--ignore-pr-patterns",
nargs="*",
type=str,
default=[MERGE_RELEASE_PR_RE],
help="List of PR patterns to ignore in the changelog (e.g., release hotfix)",
)

args = parser.parse_args()
Expand Down