Implementation:Apache Kafka Resolve Jira Issues
Appearance
| Knowledge Sources | |
|---|---|
| Domains | Development_Workflow, Project_Management |
| Last Updated | 2026-02-09 12:00 GMT |
Overview
Concrete tool for resolving Apache JIRA issues after PR merge using the jira-python library.
Description
The resolve_jira_issues function extracts JIRA IDs from the commit title and calls resolve_jira_issue for each. The inner function connects to Apache JIRA using credentials from JIRA_USERNAME and JIRA_PASSWORD environment variables, validates the issue exists, sets fix versions based on merged branches, adds a merge comment, and transitions the issue to "Resolved" with "Fixed" resolution.
Usage
Called automatically at the end of the merge workflow. Requires JIRA credentials in environment variables.
Code Reference
Source Location
- Repository: Apache Kafka
- File: committer-tools/kafka-merge-pr.py
- Lines: L264-325
Signature
def resolve_jira_issues(title, merge_branches, comment):
"""
Extracts JIRA IDs from title and resolves each.
Uses regex to find KAFKA-XXXXX patterns.
"""
def resolve_jira_issue(merge_branches, comment, default_jira_id=""):
"""
Resolves a single JIRA issue.
Sets fix versions, transitions to Resolved/Fixed,
and adds merge comment.
"""
Import
from jira import JIRA
# JIRA_USERNAME, JIRA_PASSWORD from environment
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| title | str | Yes | Commit title containing JIRA IDs |
| merge_branches | list | Yes | List of branches merged to |
| comment | str | Yes | Merge comment to add to the issue |
| JIRA_USERNAME | env | Yes | Apache JIRA username |
| JIRA_PASSWORD | env | Yes | Apache JIRA password |
Outputs
| Name | Type | Description |
|---|---|---|
| resolve_jira_issues | None | All extracted JIRA issues resolved |
| JIRA updates | remote | Issues transitioned, fix versions set, comments added |
Usage Examples
# Called at end of merge workflow
resolve_jira_issues(
title="KAFKA-12345; Fix consumer offset commit",
merge_branches=["trunk", "3.7"],
comment="Merged to trunk and 3.7 branches"
)
Related Pages
Implements Principle
Page Connections
Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment