jenkins/core-changelog-generator Docker Image

Jenkins Core Changelog Generator

镜像概述和主要用途

本镜像提供的工具用于创建Jenkins核心更新日志草稿，支持https://jenkins.io/changelog/和https://jenkins.io/changelog-stable/。生成的更新日志需提交至https://github.com/jenkins-infra/jenkins.io/tree/master/content/_data/changelogs进行维护。

核心功能和特性

generate-jenkins-changelog

• 生成Jenkins发布版本的更新日志初稿
• 支持基于版本号或提交范围（<COMMIT>..<COMMIT>）生成日志
• Docker环境下可通过卷挂载复用Jenkins源代码，自动生成changelog.yaml文件

lts-backports-changelog

• 为LTS版本生成包含反向移植问题的更新日志（基于Jira中标记为2.xyz.w-fixed的问题）
• 支持读取每周更新日志YAML文件（未指定时自动从https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml下载）
• 兼容generate-jenkins-changelog的所有配置选项

使用场景和适用范围

• Jenkins核心开发人员：快速生成每周版本的更新日志草稿
• Jenkins维护团队：为LTS版本汇总反向移植问题并生成更新日志
• 自动化工作流：集成到CI/CD流程中，自动创建更新日志并提交拉取请求

详细使用方法和配置说明

generate-jenkins-changelog工具

CLI使用

bash
# 进入Jenkins源代码目录
cd /path/to/clone/of/jenkinsci/jenkins.git
# 设置GitHub认证（用户名:令牌）
export GITHUB_AUTH=github_username:github_token

# 基于版本号生成日志
/path/to/generate-jenkins-changelog.rb <VERSION>
# 基于提交范围生成日志
/path/to/generate-jenkins-changelog.rb <COMMIT>..<COMMIT>

Docker使用

• 卷挂载：通过-v $(pwd):/github/workspace挂载当前目录，复用Jenkins源代码并在根目录生成changelog.yaml
• 无参数运行：默认生成当前分支自上次标签以来的更新日志

生成待发布变更日志示例：

bash
export GITHUB_AUTH=github_username:github_token
docker run -e GITHUB_AUTH=${GITHUB_AUTH} -v $(pwd):/github/workspace --rm docker.xuanyuan.run/jenkins/core-changelog-generator

生成指定版本日志示例：

bash
export GITHUB_AUTH=github_username:github_token
docker run -e GITHUB_AUTH=${GITHUB_AUTH} -v $(pwd):/github/workspace --rm docker.xuanyuan.run/jenkins/core-changelog-generator 2.204

lts-backports-changelog工具

CLI使用

bash
# 设置Jira认证（用户名:密码）
export JIRA_AUTH=jira_username:jira_password

# 生成LTS日志（版本号 + 每周日志YAML路径）
/path/to/lts-backports-changelog.rb <VERSION> <PATH/TO/weekly.yml>

Docker使用

• 环境变量：需设置-e CHANGELOG_TYPE=lts指定LTS模式
• 支持generate-jenkins-changelog的所有卷挂载和参数选项

生成LTS反向移植日志示例：

bash
docker run -e GITHUB_AUTH=${GITHUB_AUTH} -e JIRA_AUTH=${JIRA_AUTH} \
  -e CHANGELOG_TYPE=lts -v $(pwd):/github/workspace --rm \
  docker.xuanyuan.run/jenkins/core-changelog-generator 2.109.2

配置参数说明

环境变量

卷挂载

• -v $(pwd):/github/workspace：挂载当前目录作为工作区，用于读取源代码或输出日志文件