github-changelog

这是一个小型工具，根据GitHub拉取请求标题生成两个git标签之间的变更日志，可以是纯文本或markdown格式。

示例可能如下所示

• 改进mygreatpackage.subpackage的测试覆盖率 #1234
• 添加对Python 3的支持 #1233

安装

pip install github-changelog

使用

changelog [-h] [-m] OWNER REPO [PREVIOUS] [CURRENT]

changelog命令需要一个GitHub仓库所有者（用户或组织）、仓库名称以及零个、一个或两个标签来限制要考虑的更改集合。如果没有提供标签，则变更日志将在最新标签和HEAD之间计算。可以提供一个标签来设置与HEAD比较的基础标签。可以提供两个标签来指定基础标签和结束标签。生成的变更日志将列出在指定或推断的标签之间已合并的所有GitHub拉取请求。如果指定了-m，则输出将以markdown格式进行格式化并包含拉取请求的链接。

拉取请求合并是通过它们的提交消息标识的，通常采用Merge pull request #123…的形式。合并并压缩的拉取请求通过在提交消息第一行的末尾括号中的PR编号来识别。

示例

changelog cfpb github-changelog

将在最新标签和HEAD之间生成文本变更日志。

changelog cfpb github-changelog 1.0.0

将在1.0.0和HEAD之间生成文本变更日志。

changelog -m cfpb github-changelog 1.0.0 1.0.1

将在1.0.0和1.0.1之间生成markdown变更日志。

覆盖默认分支

默认分支设置为main。要覆盖此设置，请使用可选的--branch参数指定不同的分支。例如

changelog owner some-repo \
--branch "production"

GitHub企业支持

使用可选的 --github-base-url、--github-api-url 和 --github-token 参数连接到 GitHub Enterprise 实例。例如

changelog owner some-repo \
--github-base-url "https://github.company.com" \
--github-api-url "https://github.company.com/api/v3" \
--github-token secret-value

获取帮助

请将问题添加到 问题跟踪器。

参与进来

关于如何贡献的一般说明可以在 CONTRIBUTING 中找到。

开源许可信息

1. 条款
2. 许可证
3. CFPB 源代码政策