Sphinx插件,根据可追踪的项目创建Jira票证
mlx.jira-traceabilit的Python项目详细描述
简介
Sphinx插件,用于根据添加的可跟踪项目创建Jira票证 mlx.traceability。您可以将此模块视为 mlx.可追溯性. 在
使用
插件可以自动创建基于可追踪项目的Jira票据。仅创建票据 对于其ID 匹配的每个项配置的正则表达式item_to_ticket_regex。 根据Jira项目和 由jira_field_id配置的票证字段的值。以下是配置示例:
配置
extensions=['mlx.traceability','mlx.jira_traceability',]traceability_jira_automation={'api_endpoint':'https://jira.atlassian.com/rest/api/latest/','username':'my_username','password':'my_password','item_to_ticket_regex':r'ACTION-12345_ACTION_\d+','jira_field_id':'summary','issue_type':'Task','project_key_regex':r'ACTION-(?P<project>\d{5})_','project_key_prefix':'MLX','default_project':'SWCC','relationship_to_parent':('depends_on',r'MEETING-[\w_]+'),'components':'[SW],[HW]','description_head':'Action raised in [this meeting|https://docserver.com/<<file_name>>.html].\n\n','description_str_to_attr':{'<<file_name>>':'docname'},'warn_if_exists':False,'errors_to_warnings':True,'notify_watchers':False,}
可以选择定义project_key_regex。这个带有命名组project的正则表达式用于 提取item ID的某一部分以确定Jira项目密钥。project_key_prefix可以是可选的 定义为向project_key_regex的匹配项添加前缀。另外,default_project定义了Jira 项目键或id,以防正则表达式不匹配或尚未配置。在
item_to_ticket_regex定义用于筛选要导出为Jira票证的项id的正则表达式。 当Jira罚单已经存在时,会报告一个警告。可以通过设置禁用这些警告 warn_if_exists到True。Jira引发的错误在默认情况下会转换为警告。如果你想让这些错误 崩溃您的构建,您可以将errors_to_warnings设置为错误值。在
通过指定关系,可以将链接项的项ID添加到要创建的Jira票证的摘要中 设置relationship_to_parent的值中的此项。值可以是具有关系的列表或元组 作为第一个元素和正则表达式,以匹配作为第二个元素的链接项的ID。 此功能使您可以预先创建一个查询链接,以列出与此相关的所有Jira票据 链接项。在
通过配置description_head,可以将字符串添加到票证描述的开头。如果要创建的项 的票证没有正文,其标题将用于生成票证的说明。在
通过将notify_watchers设置为True,可以通知票证的观察者有关票证创建的信息。 请注意,只有当要分配给票证的用户与默认受让人不同时,才会发送此通知 在Jira中配置。在
属性
所有属性都是可选的,在the default configuration of mlx.traceability中定义。在
- ^{emra}用于分配
- efforce用于设置原始工作量估算字段。失败时,它会附加到描述字段。在
如果要为其创建票据的项具有通过relationship_to_parent关系链接到它的项, 此链接项的attendees属性应该是以逗号分隔的用户名列表,这些用户名被添加为观察者 到罚单上。在
字符串到项目属性的映射(高级)
如果要在 description_head设置,可以将description_str_to_attr设置设置为映射字符串的字典 希望替换为TraceableItem的属性,该属性应该取代它。在下面的示例中, 某些占位符文本将替换为项目所在的文档名称:
^{pr2}$- 项目
标签: