rcmachado/changelog

changelog

changelog 是一个命令行应用，用于读取和操作遵循 keepachangelog.com 规范的 CHANGELOG.md 文件。

它可以规范化文件（fmt）、创建发布（release）和显示特定版本（show）。详见使用方法。

核心功能和特性

• 初始化新的 CHANGELOG.md 文件，支持自定义比较链接
• 按规范添加不同类型的变更条目（Added、Changed、Deprecated等）
• 规范化变更日志格式，统一样式和结构
• 创建版本发布，自动将"Unreleased"部分转换为指定版本
• 查看特定版本或未发布的变更内容

使用场景和适用范围

适用于所有需要维护变更日志的开发项目，特别是遵循语义化版本控制和 keepachangelog.com 规范的项目。可帮助开发团队标准化变更日志管理流程，自动化版本发布记录，提高协作效率。

使用方法和配置说明

基本使用示例

bash
# 初始化新的 CHANGELOG.md 文件
$ changelog init --compare-url=https://github.com/myorg/myrepo/compare/abcdef...1234

# 在"Added" section下添加条目
$ changelog added "Initial commit"

# 创建版本发布
$ changelog release 0.1.0

安装方式

Linux 和 macOS

从 GitHub 发布页面下载[最新版本][]的预编译二进制文件。

源码安装

克隆仓库并构建可执行文件：

bash
make build

将生成的 changelog 二进制文件复制到系统路径：

bash
cp changelog /usr/local/bin

命令详解

text
changelog 用于操作和验证遵循 keepachangelog.com 规范的 markdown 变更日志文件。

用法:
  changelog [command]

可用命令:
  added       在'Added' section下添加条目
  bundle      捆绑包含未发布变更条目的文件
  changed     在'Changed' section下添加条目
  deprecated  在'Deprecated' section下添加条目
  fixed       在'Fixed' section下添加条目
  fmt         重新格式化变更日志文件
  help        关于任何命令的帮助
  init        初始化新的变更日志
  release     将"Unreleased"更改为[version]
  removed     在'Removed' section下添加条目
  security    在'Security' section下添加条目
  show        显示[version]的变更日志

标志:
  -f, --filename string   变更日志文件，或 '-' 表示标准输入 (默认 "CHANGELOG.md")
  -h, --help              帮助信息
  -o, --output string     输出文件，或 '-' 表示标准输出 (默认 "-")

使用 "changelog [command] --help" 获取有关命令的更多信息。

init 命令

初始化新的变更日志文件，包含序言和"Unreleased"版本：

bash
# 创建 CHANGELOG.md 并指定比较链接
$ changelog init -o CHANGELOG.md --compare-url https://github.com/rcmachado/changelog/compare/abcdef...HEAD
变更日志文件 'CHANGELOG.md' 创建成功。

fmt 命令

规范化变更日志格式：

bash
# 格式化默认的 CHANGELOG.md 文件
changelog fmt

# 格式化指定文件并输出到标准输出
changelog fmt -f my-changelog.md -o -

show 命令

查看变更日志内容：

bash
# 查看未发布的变更
changelog show Unreleased

# 查看特定版本的变更
changelog show 1.2.3

release 命令

创建新的版本发布：

bash
# 将 Unreleased 部分转换为 1.2.4 版本
changelog release 1.2.4

格式化规则

fmt 命令应用以下规范化转换：

• 按固定顺序排序 sections（Added、Changed、Deprecated、Removed、Fixed、Security）
• 版本链接统一放置在文件底部
• 列表符号统一使用 -

贡献

欢迎 Fork 并提交 PR。可查看 https://github.com/rcmachado/changelog 标签获取贡献想法。

许可

采用 MIT 许可。详见仓库中的 LICENSE 文件。