生成变更日志

使用您的提交日志来制作一个美观的变更日志文件。

• 文档
• GitHub

generate-changelog 做的是它所说的：生成完整的变更日志或更新现有的一个。Git标签和提交是 generate-changelog 执行任务输入。

此工具的主要目标是提供 常规提交 的好处，而不需要严格的语法。 generate-changelog 使用可配置的正则表达式或提交元数据匹配来实现这一点。想法是自然语言更容易让开发者记住，并且需要更少的工具来强制执行。

功能

提交和标签处理

• 根据正则表达式匹配过滤提交和标签。
• 使用可配置的正则表达式、元数据或自定义标准将提交消息分类到“新”、“修复”和“变更”等部分。
• 使用操作管道重写提交摘要或提交正文。
• 从提交摘要或正文中提取部分内容到可供模板和过滤器使用的元数据。
• 内置Jira、GitHub、Azure DevOps Board问题解析器。
• 内置常规提交解析器

更改日志渲染

• 使用Jinja模板进行模板化。
• 每个模板都包含大量元数据，允许链接到提交、版本差异和问题跟踪器。
• 轻松自定义您想要的模板。
• 支持完整或增量更改日志生成。

发布提示

• 可以使用用户定义的规则来建议用于CI管道另一部分的发布类型。

Git支持

• 支持您的合并或变基工作流程和复杂的Git历史。
• 通过可配置的跟踪器键值支持一个提交的多作者。
• 内置解析器，将跟踪器键值转换为元数据。

要求

Python 3.7或更高版本。

安装

$ pip install generate-changelog

使用

创建默认配置文件。

$ generate-changelog --generate-config

这会创建一个名为.changelog-config.yaml的文件。您可以更改默认配置。

通过以下方式生成您的更改日志：

$ generate-changelog