jira和email的模板引擎。使用yaml和jinja2。它可以帮助您从模板创建多个(可能是交叉链接的)jira问题和电子邮件。
workflow-templater的Python项目详细描述
简介
jira和email的模板引擎。使用yaml和jinja2。它可以帮助您从模板创建多个(可能是交叉链接的)jira问题和电子邮件。
目录
安装
窗口
- 从Releases page上的最新版本下载workflow\u templater{version}.exe。
- 安装它。
- 现在
workflow-templater
可执行文件应该可以从windows命令提示符(cmd.exe
)获得。
Mac操作系统
- 安装python≥3.7。
- 使用正式的python安装程序:
- 从https://python.org/(“MacOS 64位安装程序”)安装python≥3.7
- 安装python的ca证书,在终端中执行:
或者,您可以双击finder中的/Applications/Python\ 3.7/Install\ Certificates.command
Install Certificates.command
- 或者使用Homebrew:
brew install python
- 使用正式的python安装程序:
pip3 install workflow-templater
其他任何东西(gnu/linux、cygwin、*nix等)
使用pip
- 确保安装了python≥3.7
pip3 install workflow-templater
使用eggsecutable
- 从Releases page上的最新版本下载workflow\u templater-${version}-py3.x.egg。
- 可以直接执行,也可以使用
/bin/sh
(如果安装了兼容的python和依赖项):./workflow_templater-${version}-py3.x.egg --help sh ./workflow_templater-${version}-py3.x.egg --help
来源
- 克隆此回购协议
- 如果需要,请安装依赖项
pip3 install -r requirements.txt
- 可以直接执行脚本:
或者安装/构建/使用cd workflow_templater ./workflow_templater/__init__.py --help
python3 setup.py
用法
请参见
workflow-templater --help
配置
为了避免每次都键入相同的命令行参数,可以在配置文件中指定它们。配置文件位置是特定于操作系统的,若要查找操作系统的正确位置,请执行workflow-templater --help
,您将看到消息“-config config overwrite config file path,default is${location}”,其中${location}是配置文件在操作系统上的位置。可以创建此文件并指定命令行参数的值,忽略--
,并用_
替换-
,例如,--jira-user j_wayne
变成jira_user: j_wayne
,--dry-run
变成dry_run: true
等等。您还可以在配置文件中使用jinja2,该文件使用自身的变量进行求值。
示例~/.config/workflow-templater/config.yaml
:
dry_run:trueverbose:trueuser:j_waynejira:https://jira.example.com/jira_user:'{{user}}'email_user:'{{user}}'email_from:'{{user}}@example.com'email_smtp:'smtp.example.com:587'# avoid typing in the same password for jira and emailjira_keyring_service_name:'MyCorpLDAP'email_keyring_service_name:'MyCorpLDAP'
模板说明
概述
- 整个工作流模板是一个目录。
- 应该有一个变量名为
0_common.yaml
、00_common.yaml
或common.yaml
的文件。 - 可能有任何数量的“issue”文件:以“.jira.yaml”结尾的文件用于jira issue,以“.email.yaml”结尾的文件用于email。
- 每个“issue”文件都是yaml文件,其中每个字符串值使用Jinja2文件中的变量来呈现。
示例
有关基本示例,请参见basic release example。