Jira Off-load Tool - JOFT

这是什么？

JOFT是一个用于在JIRA实例上自动化用户操作的命令行工具。这是因为它创建的原因是当您想要在不拥有实例管理员权限的情况下执行复杂操作时，JIRA内置的自动化功能不足。

它是如何工作的？

要使用JOFT进行自动化，您首先需要编写一个yaml模板文件，该文件实际上将包含您想要执行的操作。您可以从JQL触发查询或没有它来对问题执行操作。

如果您在yaml文件中提供了特定的触发JQL查询，那么yaml模板文件中定义的所有描述性操作将在触发JQL查询找到的每个问题上执行一次。yaml模板文件只能有JQL触发查询。如果您需要更多，请创建另一个包含不同查询的yaml模板文件。

如果您不提供触发JQL查询，则定义的操作将执行一次。

安装

克隆存储库。使用您喜欢的工具创建一个虚拟环境，只需确保Python版本为3.11或更高。

要安装此工具，请转到项目的根目录，激活您的venv，然后运行pip install .。对于开发，请运行pip install -e .。

要运行所有测试和类型检查器，请运行tox。

用法

首先，您需要拥有一个Jira实例以及该实例上的账户。然后，您需要获取您的个人访问令牌（PAT），您可以访问PAT令牌页面。为了能够使用JOFT，请在项目文件夹的根目录下为您Jira实例创建一个配置文件。项目文件夹中有一个默认配置示例您可以使用，文件名为joft.config.toml.default。只需删除文件名末尾的.default，然后添加您的凭据即可。

要获取帮助，请在命令行界面中不带任何选项运行工具。

joft.

要验证您的YAML模板文件，请运行

joft validate --template ./<您的yaml模板路径>

要运行YAML模板文件中的操作，请运行

joft run --template ./<您的yaml模板路径>

文档

文档可在此处找到：这里。