00freezy00/gitlab-release-note-generator

Gitlab发布说明生成器

一个基于Gitlab最新标签生成发布说明的工具。

核心功能

• 根据最新标签生成发布说明，包含该标签范围内的合并请求和问题
• 按标签（enhancement、breaking change、feature、bug）区分展示内容（若同一项有多个标签，会在对应分类下重复显示）
• 支持集成到CD服务或Gitlab CI流程中

使用场景

• Gitlab项目发布新版本时自动生成结构化发布说明
• 团队协作中快速汇总版本更新内容
• 自动化CI/CD流程中添加发布说明生成步骤

配置说明

通过环境变量指定配置参数：

• GITLAB_API_ENDPOINT：Gitlab实例的API地址，默认值为https://gitlab.com/api/v4
• GITLAB_PERSONAL_TOKEN：具有api权限的Gitlab个人访问令牌
• GITLAB_PROJECT_ID：项目ID（位于设置>通用中）
• TARGET_BRANCH：指定查找标签的分支（可选）
• TARGET_TAG_REGEX：标签的正则表达式（可选，用于筛选特定标签）
• TZ：时区，默认值为Australia/Melbourne
• ISSUE_CLOSED_SECONDS：搜索提交后问题关闭的时间范围（秒），默认值为0

Docker部署示例

基础运行命令

shell
docker container run -e GITLAB_PERSONAL_TOKEN=你的令牌 -e GITLAB_PROJECT_ID=你的项目ID -e TARGET_BRANCH=master -e TARGET_TAG_REGEX=^release-.*$ 00freezy00/gitlab-release-note-generator

本地构建并运行

bash
# 导出环境变量
export GITLAB_PERSONAL_TOKEN=你的令牌
export GITLAB_PROJECT_ID=你的项目ID
export GITLAB_API_ENDPOINT=https://你的Gitlab实例/api/v4

# 构建本地镜像
docker build -t local-gitlab-release-note-generator .

# 运行本地镜像
docker container run \
  -e TZ=America/New_York \
  -e GITLAB_API_ENDPOINT=$GITLAB_API_ENDPOINT \
  -e GITLAB_PERSONAL_TOKEN=$GITLAB_PERSONAL_TOKEN \
  -e GITLAB_PROJECT_ID=$GITLAB_PROJECT_ID \
  -e TARGET_BRANCH=master \
  -e TARGET_TAG_REGEX=^release-.*$ \
  local-gitlab-release-note-generator

Gitlab CI集成方法

1. 在Gitlab项目中添加CI变量GITLAB_PERSONAL_TOKEN（值为你的令牌）
2. 将.sample.gitlab-ci.yml复制到项目根目录，该文件包含：
   • generate-release-note任务：检测符合/^[0-9]+\.[0-9]+\.[0-9]+(-[0-9]+)?$/的标签推送后生成发布说明
   • tag-after-deployment任务（可选）：为包含版本更新的提交打标签（需SSH密钥支持）
3. 根据项目需求自定义CI脚本

参考项目：https://gitlab.com/jackzhang/generator-test

待办功能

• 支持指定标签生成发布说明
• 允许自定义发布说明模板

致谢

感谢https://github.com/github-changelog-generator/github-changelog-generator提供灵感。