pokainc/github-changelog-generator

pokainc/github-changelog-generator 镜像说明

镜像概述

本Docker镜像封装了开源工具skywinder/github-changelog-generator，旨在帮助开发者快速从GitHub仓库提取提交记录和标签信息，自动生成规范的变更日志文档，提升版本发布流程的效率。

核心功能

• 自动获取GitHub仓库的提交历史、标签及Pull Request数据
• 支持过滤特定类型的提交（如bug修复、新功能、文档更新等）
• 可自定义变更日志的输出格式、标题分类与内容范围
• 兼容私有仓库（需配置GitHub访问令牌）
• 提供灵活的参数配置（命令行/环境变量）

使用场景

• 项目版本发布时生成正式变更日志
• 定期整理项目迭代的更新记录
• 团队协作中同步版本变更内容
• 自动化CI/CD流程中集成日志生成步骤

配置说明

关键参数

• 环境变量：GITHUB_TOKEN（必填，突破GitHub API访问限制）
• 命令行参数：
  • -u/--user：GitHub用户名
  • -p/--project：仓库名称
  • --since-tag：起始标签（可选，指定从哪个版本开始生成）
  • --output：输出文件路径（默认：CHANGELOG.md）

部署示例

Docker Run命令

bash
docker run --rm \
  -e GITHUB_TOKEN=your_personal_access_token \
  docker.xuanyuan.run/pokainc/github-changelog-generator \
  -u your_github_username \
  -p your_repository_name \
  --output ./CHANGELOG.md

说明

替换上述命令中的your_personal_access_token、your_github_username和your_repository_name为实际值，即可生成对应仓库的变更日志文件。