在GitHub上创建和更新请求的工具。
lazypr的Python项目详细描述
在GitHub上创建和更新请求的工具
与Jira API集成,获取相应的Jira票证标题并进行设置 在拉请求中(在分支名称和jira票证密钥之间完成映射) “项目xxxx”->;“项目-xxxx”)。在
可以在配置中指定请求请求描述模板路径。在
支持在请求请求中设置团队审阅者。在
使用
创建配置文件~/.config/lazy_pr.ini
,并在那里设置以下值:
[default]jira-api-token=<jira api token>jira-email=<jira email>github-token=<your github token>repo=<repository>repo-path=<repository local path>pr-base=masterpr-team=<team on github>pr-desc=<pull request template file local path>
或者,可以将.ini配置文件的路径指定为命令行
参数(-c
或--config-file-path
)。在
命令行参数-cs
或--config-section
可用于指定配置
第节。如果未指定,则使用“默认”部分。在
选项可以在配置文件中设置为环境变量或
命令行参数(运行lazypr --help
获取更多详细信息):
usage:lazypr[-h][-cCONFIG_FILE_PATH][-csCONFIG_SECTION][-jtJIRA_API_TOKEN][-jeJIRA_EMAIL][-gtGITHUB_TOKEN][-rREPO][-rpREPO_PATH][-bBRANCH][-sPR_BASE][-tPR_TITLE][-dPR_DESC][-tmPR_TEAM]
示例
- 为存储库
sanjaz/lazypr
中的分支lp_1
创建拉取请求。在
分支和存储库都可以指定为命令行参数:
lazypr-r"sanjaz/lazypr"-b"lp_1"`
如果repository命令行arg被省略,则将从
repo
配置文件中的值。在
lazypr-b"lp_1"
如果未指定分支,它将在本地查找当前分支
存储库(本地存储库路径在.ini配置文件的repo-path
中设置):
lazypr
或者可以将本地存储库路径指定为命令行参数(和当前参数 将使用本地存储库中的分支):
lazypr-rp"/home/sanja/moto/lazypr"
- 可以使用命令行参数
-t
指定请求标题 (--title
):
lazypr-b"lazypr_1"-t"Test title"
如果没有指定,标题将从相应的Jira票据中获取。 分支名称映射到Jira票证密钥,即proj_xxxx->;proj_xxxx。在
- 拉取请求描述模板路径是否可以在.ini中指定
配置文件(
pr-desc
)、env变量或作为命令行参数-d
(--pr-desc
)。在
lazypr-d"/home/sanja/moto/lazypr/.github/PULL_REQUEST_TEMPLATE.md"
- 拉请求基本分支(请求将位于的目标分支 合并)可以指定为命令行参数:
lazypr-s"release"
如果在主文件中指定了.ini,则通常省略。在
- 可指派GiHub团队审查拉取请求:
lazypr-tm"my-team"
如果省略,则在.ini配置文件中指定默认值。在
注释
- 如何查找/生成Jira API令牌:登录 https://id.atlassian.com/manage/api-tokens并单击“创建API令牌”。 有关详细信息,请查看 https://confluence.atlassian.com/cloud/api-tokens-938839638.html
- 如何找到您的用户Jira电子邮件: https://id.atlassian.com/manage-profile/email
- 如何查找/生成github令牌:https://github.com/settings/tokens。 一些细节可以在这里找到:https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line
- 项目
标签: