摘要:在 Jira 项目管理系统中,当story主任务处于特定状态(如 “READY FOR PM” 或 “已关闭”)时,需要对其所有子任务的状态进行更新。为了实现这一自动化操作,编写了一个 Python 脚本,以提高工作效率和准确性。
一、项目背景
在 Jira 项目管理系统中,当story主任务处于特定状态(如 “READY FOR PM” 或 “已关闭”)时,需要对其所有子任务的状态进行更新。为了实现这一自动化操作,编写了一个 Python 脚本,以提高工作效率和准确性。
二、技术选型
编程语言:Python,因其简洁易读的语法和丰富的第三方库,适合快速开发脚本。
Jira 库:jira-python,用于与 Jira 服务器进行交互,实现问题的搜索、状态查询和更新等操作。
三、实现思路
3.1 整体流程
登录 Jira 服务器,获取 Jira 实例。
执行 JQL 查询,获取符合条件的主任务列表。
遍历每个主任务,检查是否有子任务。
若主任务处于特定状态,遍历其子任务并更新状态。
3.2 状态更新逻辑
对于每个子任务,按以下顺序尝试更新状态:
尝试将状态更新为 “开放”。
尝试将状态更新为 “code review”。
尝试将状态更新为 “Done”,更新成功后停止后续操作。
四、代码实现
def update_issue_status(jira_instance, issue, transition_name):try:
transitions = jira_instance.transitions(issue)
for transition in transitions:
if transition['name'] == transition_name:
transition_id = transition['id']
print(f"transition['name']: {transition_name}")
print(f"transition_id: {transition_id}")
jira_instance.transition_issue(issue, transition_id)
print(f"子任务 {issue.key} 状态已更新为:{transition_name}")
return True
print(f"未找到 {transition_name} 状态过渡")
return False
except JIRAError as e:
print(f"更新 {issue.key} 状态时出错: {e}")
return False
# 处理子任务的逻辑
def process_subtasks(jira_instance, parent_issue, subtasks):
print(f"主任务状态: {parent_issue.fields.status.name}")
print(f"主任务 {parent_issue.key} 的子任务:")
target_statuses = ["READY FOR PM", "已关闭"]
if parent_issue.fields.status.name in target_statuses:
for subtask in subtasks:
print(f"KEY: {subtask.key}")
print(f"摘要: {subtask.fields.summary}")
print(f"状态: {subtask.fields.status.name}")
flag = 1
while True:
if subtask.fields.status.name == "完成":
break
if flag == 0:
break
update_issue_status(jira_instance, subtask, "code review")
update_issue_status(jira_instance, subtask, "开放")
if update_issue_status(jira_instance, subtask, "Done"):
flag = 0
print("-" * 50)
# 搜索问题的主函数
def search(jira_instance, jql_query):
try:
issues = jira_instance.search_issues(jql_query)
for issue in issues:
parent_issue_key = issue.key
parent_issue = jira_instance.issue(parent_issue_key)
subtasks = parent_issue.fields.subtasks
if not subtasks:
print("没有子任务")
else:
process_subtasks(jira_instance, parent_issue, subtasks)
except JIRAError as e:
print(f"Error searching issues: {e}")
五、使用方法
安装依赖:确保已经安装 jira-python 库,可以使用以下命令进行安装:
pip install jira
1
实现登录逻辑:在 login 函数中实现登录 Jira 服务器的逻辑,示例代码如下:
from jira import JIRAdef login:
options = {
'server': 'https://your-jira-server-url'
}
jira = JIRA(options, basic_auth=('your-username', 'your-password'))
return jira
修改 JQL 查询:根据实际需求修改 jql_query 的值,以获取符合条件的主任务列表。
运行脚本:在命令行中运行脚本:
python script.py
六、注意事项
确保 Jira 服务器的访问权限和网络连接正常。
若 Jira 服务器有速率限制,并行处理可能会导致请求被拒绝,需要根据实际情况调整线程池的大小。
脚本执行过程中,若出现异常,会在控制台输出错误信息,可根据错误信息进行排查和修复。
七、未来扩展
支持更多的 JQL 查询条件,以满足不同的业务需求。
实现批量状态更新功能,进一步提高执行效率。
增加日志记录功能,将脚本的执行过程和结果记录到文件中,方便后续分析和审计。
```pythonfrom jira import JIRA import sys
failSummaryList = def login: # Jira服务器地址,用户名和密码 jira_server = 'https://jira.xxxx.com' jira_user = 'xxxx' jira_password = 'xxxxxx' # 创建Jira实例并登录 try: jira_instance = JIRA(server=jira_server, basic_auth=(jira_user, jira_password)) print("Logged in successfully.") except JIRAError as e: print(f"Failed to log in to Jira: {e}") return jira_instance
from jira import JIRAError
封装状态更新逻辑
def update_issue_status(jira_instance, issue, transition_name): try: transitions = jira_instance.transitions(issue) for transition in transitions: if transition['name'] == transition_name: transition_id = transition['id'] print(f"transition['name']: {transition_name}") print(f"transition_id: {transition_id}") jira_instance.transition_issue(issue, transition_id) print(f"子任务 {issue.key} 状态已更新为:{transition_name}") return True print(f"未找到 {transition_name} 状态过渡") return False except JIRAError as e: print(f"更新 {issue.key} 状态时出错: {e}") return False
处理子任务的逻辑
def process_subtasks(jira_instance, parent_issue, subtasks): print(f"主任务状态: {parent_issue.fields.status.name}") print(f"主任务 {parent_issue.key} 的子任务:") target_statuses = ["READY FOR PM", "已关闭"] if parent_issue.fields.status.name in target_statuses: for subtask in subtasks: print(f"KEY: {subtask.key}") print(f"摘要: {subtask.fields.summary}") print(f"状态: {subtask.fields.status.name}") flag = 1 while True: if subtask.fields.status.name == "完成": break if flag == 0: break update_issue_status(jira_instance, subtask, "code review") update_issue_status(jira_instance, subtask, "开放") if update_issue_status(jira_instance, subtask, "Done"): flag = 0 print("-" * 50)
搜索问题的主函数
def search(jira_instance, jql_query): try: issues = jira_instance.search_issues(jql_query) for issue in issues: parent_issue_key = issue.key parent_issue = jira_instance.issue(parent_issue_key) subtasks = parent_issue.fields.subtasks if not subtasks: print("没有子任务") else: process_subtasks(jira_instance, parent_issue, subtasks) except JIRAError as e: print(f"Error searching issues: {e}")
if name == 'main': jql_query = sys.argv[1] print(f"jql_query:{jql_query}") jira_instance = login # jql_query = "type = story AND xxx=xxx" search(jira_instance, jql_query) ```
本文永久更新地址:
https://www.fenxiangbe.com/p/Jira获取story信息更新子任务状态脚本技术实现.html
来源:吾爱乐享