Add support for exempting i18n/translation commits from Redmine validation #200

ogajduse · 2025-09-02T10:19:30Z

Summary

Add exempt_patterns configuration to allow specific commit message patterns to bypass Redmine validation requirements
Implement global default patterns applied to all repositories with repository-specific override capability
Add regex pattern matching for flexible commit message formats
Maintain backward compatibility with existing configuration

Background

Resolves the issue discussed in theforeman/theforeman-rel-eng#519 (comment) where translation/internationalization commits often don't have specific Redmine issues associated with them, causing legitimate commits to fail validation.

Changes

Added exempt_patterns field to Config dataclass
Updated configuration loading to support global_config section with repository override behavior
Implemented is_commit_exempt() function with regex pattern matching
Modified commit validation in get_issues_from_pr() to check exemptions before marking commits invalid
Added global i18n patterns to repos.yaml for common translation workflows
Fixed edge case with empty commit messages in subject property

Global Patterns Added

"^i18n - " - Matches "i18n - Update Japanese translations"
"^Localization - " - Matches "Localization - Fix German strings"
"^Update translations" - Matches "Update translations for 3.5 release"
"^Automatic locale update" - Matches "Automatic locale update from Crowdin"

Configuration Examples

# Repository uses global patterns (no local exempt_patterns defined)
theforeman/foreman:
  redmine: foreman
  redmine_required: true
  # Gets global patterns automatically

# Repository completely overrides global patterns  
theforeman/special-repo:
  redmine: special
  redmine_required: true
  exempt_patterns:
    - "^Bot update - "
  # Gets only these patterns (global patterns replaced)

Test plan

Manual testing of exempt pattern matching functionality
Verification of configuration loading with global and repository-specific patterns
Testing edge cases (empty commits, no patterns)
Validation that existing behavior remains unchanged for repos without exempt patterns

🤖 Generated with Claude Code

ekohl

I think the whole config is a bit excessive. There should only be a single pattern and I'd be inclined to hardcode it. Then you can use re.compile and reuse the compiled pattern. You can also simplify the code a lot by making it a simple is_exempt method on the Commit class. That keeps rest of the logic easier as well.

ekohl · 2025-09-02T10:25:01Z

prprocessor/__main__.py


+def is_commit_exempt(commit: Commit, exempt_patterns: list) -> bool:
+    """Check if commit subject matches any exemption pattern."""
+    import re


Can this be a top level import?

ekohl · 2025-09-02T10:25:30Z

prprocessor/__main__.py

+    for pattern in exempt_patterns:
+        if re.search(pattern, commit.subject, re.IGNORECASE):
+            return True
+    return False


Maybe a bit of code golfing

Suggested change

for pattern in exempt_patterns:

if re.search(pattern, commit.subject, re.IGNORECASE):

return True

return False

return any(re.search(pattern, commit.subject, re.IGNORECASE) for pattern in exempt_patterns)

I was thinking about that too.

ekohl · 2025-09-02T10:26:34Z

prprocessor/__main__.py

        issue_ids.update(commit.refs)
        if config.required and not commit.fixes and not commit.refs:
-            invalid_commits.append(commit)
+            if not is_commit_exempt(commit, config.exempt_patterns):


Any particular reason you didn't add this to the existing if statement? Would the line become too long?

If we had some specific (I do not exactly remember which one) flake ruleset enabled here, it would point out the very same thing. Will fix it.

ekohl · 2025-09-02T10:27:36Z

prprocessor/config/repos.yaml

+    - "^i18n - "
+    - "^Localization - "
+    - "^Update translations"
+    - "^Automatic locale update"


I don't like the many variations for this. In our code base we only have 2 and let's keep it that way

Suggested change

- "^i18n - "

- "^Localization - "

- "^Update translations"

- "^Automatic locale update"

- "^i18n - (extracting new, )?pulling from tx$"

Sources:

https://github.com/theforeman/foreman/blob/ee1afb939ebfea220177b5066c4bb9744721cdfe/locale/Makefile#L62

https://github.com/theforeman/foreman_plugin_template/blob/f92b585db9ddd4d8fc9c2bc3209162962157a67c/locale/Makefile#L70

https://github.com/theforeman/hammer-cli/blob/737ec089d22d01aa537764dc9b6be0f1b8718a64/lib/hammer_cli/i18n/find_task.rb#L92

Right, sort of wanted to have a discussion about this - if the i18n one is the only one we want to have in at this moment.

I'll leave only that one there then.

ogajduse · 2025-09-02T11:16:52Z

I've tried to address all your comments. Could you please re-review @ekohl?

ekohl

Thanks! I think this is a lot simpler to understand (and thus maintain).

ekohl · 2025-09-04T18:47:52Z

prprocessor/__main__.py

    re.IGNORECASE,
 )
 COMMIT_ISSUES_REGEX = re.compile(r'#(\d+)')
+EXEMPT_COMMIT_REGEX = re.compile(r'^i18n\s*-', re.IGNORECASE)


I think we can be more specific here to keep them standardized. Since they're typically generated by scripts that should be fine.

Suggested change

EXEMPT_COMMIT_REGEX = re.compile(r'^i18n\s*-', re.IGNORECASE)

EXEMPT_COMMIT_REGEX = re.compile(r'^i18n - (extracting new, )?pulling from tx$', re.IGNORECASE)

…dmine validation Add simple i18n commit exemption to allow translation commits to bypass Redmine validation requirements while maintaining validation for regular commits. Implementation: - Add hardcoded regex pattern for i18n commits (^i18n\s*- case insensitive) - Use compiled regex for performance - Add is_exempt() method to Commit class for clean encapsulation - Integrate exemption check into existing validation logic This allows commits like "i18n - Update Japanese translations" to pass validation without requiring Redmine issue references, addressing the workflow issue discussed in theforeman/theforeman-rel-eng#519. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

ekohl requested changes Sep 2, 2025

View reviewed changes

pr-processor bot added the Waiting on contributor label Sep 2, 2025

ekohl linked an issue Sep 2, 2025 that may be closed by this pull request

Add support for exempting i18n/translation commits from Redmine validation #199

Open

ogajduse force-pushed the feature/exempt-i18n-commits branch from 656d87a to b338814 Compare September 2, 2025 11:15

ogajduse requested a review from ekohl September 2, 2025 11:16

ogajduse mentioned this pull request Sep 2, 2025

Add automated translation workflow scripts and improve procedures theforeman/theforeman-rel-eng#519

Merged

ekohl reviewed Sep 4, 2025

View reviewed changes

ogajduse force-pushed the feature/exempt-i18n-commits branch from b338814 to 17148eb Compare September 12, 2025 13:37

ogajduse requested a review from ekohl September 12, 2025 13:37

	EXEMPT_COMMIT_REGEX = re.compile(r'^i18n\s*-', re.IGNORECASE)
	EXEMPT_COMMIT_REGEX = re.compile(r'^i18n - (extracting new, )?pulling from tx$', re.IGNORECASE)

Add support for exempting i18n/translation commits from Redmine validation #200

Are you sure you want to change the base?

Add support for exempting i18n/translation commits from Redmine validation #200

Uh oh!

Conversation

ogajduse commented Sep 2, 2025

Summary

Background

Changes

Global Patterns Added

Configuration Examples

Test plan

Uh oh!

ekohl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ogajduse commented Sep 2, 2025

Uh oh!

ekohl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants