从api或命令行与jira接口的简单帮助程序。
jiratools的Python项目详细描述
一些简单的api函数和与jira交互的命令行工具。
设置
这里的所有工具和功能都需要 在主目录中有一个jira.config文件，因此您必须执行此设置 在使用任何东西之前：
- 运行jira-example-config--install以安装示例配置文件 （不需要--install就可以运行它来查看 安装.（如果您的主目录中已经有一个jira.config， 此脚本将不覆盖它。
- 用适当的数据填写配置文件中的值 （有关指导，请参阅该文件中的注释）。
命令行工具
jira-example-config可以为您安装一个示例配置文件，见上文。
< P> ^ {TT6}$创建了一个新的JIRA问题，该问题与一个现存的问题有关； 可以从^{tt1}中的默认值设置新问题的字段$ 或者可以在命令行上重写这些值。 有关所有命令行选项，请参见此命令上的--help， 以及jira.config中用于设置默认值的注释。jira-add-comment向jira问题添加注释。 向jira进行身份验证需要jira.config文件。 此命令不使用jira.config文件中的其他数据。 有关详细信息，请参见此命令的--help。您还可以使用-作为注释 而jira-add-comment将从stdin读取注释。注意如果你 以交互方式使用-，您不能在发布评论之前对其进行编辑。
jira-search-issues使用jql查询搜索jira。 向jira进行身份验证需要jira.config文件。 您可以设置默认的最大整数结果值 作为MAX_RESULT_COUNT在jira.config中， 或者在默认情况下为no max设置值-1。 有关详细信息，请参见此命令的--help。
jira-link-issues在两个问题之间创建链接。 向jira进行身份验证需要jira.config。
jira-update-assignee将jira的受让人更改为提供的用户。
错误日志工具
这些函数设计用于python代码中 帮助处理各种错误注释逻辑。
- jiratools.error_logging.add_jira_error_comment可能出错 并将格式化的注释添加到相关的JIRA问题中
- jiratools.error_logging.add_jira_comment_with_table可以添加注释 将格式化数据表转换为JIRA问题
- jiratools.error_logging.update_jira_for_errors可以检查找到的错误 针对一系列的JIRA问题 并为找到匹配项的任何jira问题添加注释。
格式化工具
这些函数设计用于python代码中 帮助设置注释格式逻辑。
- jiratools.formatting.format_autoupdate_jira_msg接受消息正文 并添加相关标题/标题数据
- jiratools.formatting.format_as_jira_table接受头和表行 并设置jira样式表的格式
示例
- jira-add-commentJIRA-1234 "Work in Progress. PR delayed by network problems." –使用来自^{tt1}的用户/密码将注释添加到jira-1234$ 注意，注释必须只有一个命令行参数，并用引号括起来 如果它包含空格等。
- jira-make-linked-issueJIRA-1234 –将在TEST_PROJECT中创建一个jira来测试jira-1234， 把两者联系起来，分配给你 添加默认观察者列表中指定的任何观察者。
- jira-make-linked-issueJIRA-1234--project OTHER –将创建如上所述的测试jira，但在OTHER
- jira-make-linked-issueJIRA-1234--user bobm5523 –将创建如上所述的jira，但分配给bobm5523
- jira-make-linked-issueJIRA-1234-w sall9987 -w benj4444 –将创建jira并将sall9987和benj4444分配为观察者 而不是默认的观察者列表
- jira-search-issues "project=ABC AND summary ~ client" –将打印项目ABC中问题的链接和标题列表 在总结中包括“客户”一词。
- jira-link-issuesABC-123XYZ-456 –将创建一个链接，使ABC-123与XYZ-456
欢迎加入QQ群-->： 979659372
