jimschubert/changelog

GitHub Changelog Generator镜像说明

镜像概述

本镜像基于jimschubert/changelog构建，是一款跨平台的GitHub仓库变更日志生成工具。它通过调用GitHub Commits API获取指定分支或标签间的提交记录，支持自定义模板、分组规则与排除条件，帮助开发者高效生成规范的变更日志文档。

核心功能

• GitHub API集成：支持查询任意两个Git分支/标签间的提交记录；
• 自定义模板：基于Go Text Template语法，可自定义变更日志输出格式；
• 提交分组：通过正则表达式将提交按指定标题分组展示；
• 提交排除：支持过滤掉不需要的提交记录（如维护类提交）；
• 本地优先：可优先使用本地Git仓库的提交记录，减少API依赖；
• 环境变量支持：可通过环境变量配置GitHub Owner、Repo与Token，方便CI/CD集成。

使用场景

• 项目版本发布时，快速生成结构化的变更日志；
• CI/CD流程中自动更新项目的CHANGELOG.md文件；
• 自定义变更日志格式，满足团队或项目的特定规范要求；
• 批量处理历史提交记录，生成版本间的变更对比文档。

配置说明

环境变量

• GITHUB_TOKEN：必填，GitHub访问令牌（需具备仓库读取权限）；
• GITHUB_OWNER：必填，GitHub仓库所有者/组织名称；
• GITHUB_REPO：必填，GitHub仓库名称。

命令行参数

• -f, --from：变更日志起始提交或标签；
• -t, --to：变更日志结束提交或标签（默认master）；
• -c, --config：高级配置文件路径（JSON格式）；
• -l, --local：优先使用本地Git提交记录；
• --max：最大包含的提交数量。

高级配置（JSON文件）

支持配置resolve方式、排序规则、自定义模板路径、分组规则、排除规则等，示例：

json
{
  "sort": "desc",
  "template": "/path/to/custom/template.tmpl",
  "groupings": [
    {"name": "Fixes", "patterns": ["(?i)\\bbug\\b", "(?i)\\bfix\\b"]},
    {"name": "Features", "patterns": ["^(?i)feat:"]}
  ],
  "exclude": ["^(?i)release\\s+\\d+\\.\\d+\\.\\d+", "(?i)\\btypo\\b"]
}

Docker部署示例

拉取镜像

bash
docker pull jimschubert/changelog:latest

生成变更日志（从v1.0到v1.1）

bash
docker run -e GITHUB_TOKEN=your_github_token \
           -e GITHUB_OWNER=your_owner \
           -e GITHUB_REPO=your_repo \
   jimschubert/changelog:latest -f v1.0 -t v1.1 >> CHANGELOG.md

使用高级配置文件

bash
docker run -e GITHUB_TOKEN=your_github_token \
           -v /local/config:/config \
   jimschubert/changelog:latest -o your_owner -r your_repo -f v1.0 -t v1.1 -c /config/config.json >> CHANGELOG.md

注意事项

• GitHub API存在限制：每小时最多5000次请求，单次比较最多返回250条提交；
• 自定义模板需遵循Go Text Template语法，且路径需在容器内可访问；
• 本地模式需确保容器内可访问Git仓库目录（可通过-v挂载本地仓库）。

许可证

本镜像对应的项目采用Apache 2.0许可证开源，详情见https://github.com/jimschubert/changelog%E3%80%82