auto-changelog 使用教程

auto-changelog 使用教程

1、项目介绍

auto-changelog 是一个用于生成格式良好的变更日志的简单工具。它基于版本控制系统（VCS）中的提交信息，使用传统的提交消息样式来生成变更日志。该项目支持 Python 3.7 及以上版本，并且遵循 MIT 许可证。

2、项目快速启动

安装

你可以通过 pip 安装 auto-changelog：

pip install auto-changelog

或者直接从源码安装（使用 Poetry）：

poetry install
poetry build
pip install dist/*.whl

使用

你可以通过运行以下命令来查看命令行选项：

auto-changelog --help

生成变更日志

在你的项目目录中运行以下命令来生成变更日志：

auto-changelog

3、应用案例和最佳实践

应用案例

假设你有一个项目 my-awesome-package，你可以在 package.json 中配置 auto-changelog 选项：

{
  "name": "my-awesome-package",
  "version": "1.0.0",
  "scripts": {
    // 其他脚本
  },
  "auto-changelog": {
    "output": "HISTORY.md",
    "template": "keepachangelog",
    "unreleased": true,
    "commitLimit": false
  }
}

最佳实践

• 使用模板：选择合适的模板来生成变更日志，例如 keepachangelog 模板。
• 包含未发布变更：设置 unreleased 为 true，以便在变更日志中包含未发布的变更。
• 禁用提交限制：设置 commitLimit 为 false，以包含所有提交记录。

4、典型生态项目

auto-changelog 可以与其他开源项目结合使用，例如：

• Poetry：用于 Python 包管理的工具，可以与 auto-changelog 一起使用来管理项目的依赖和构建过程。
• pre-commit：用于管理 Git 钩子的工具，可以在提交代码前自动运行 auto-changelog 来生成变更日志。

通过这些工具的结合使用，可以提高项目的开发效率和代码质量。