主题
一、Jenkins Job Configuration History 插件使用手册
1.1 插件简介
Job Configuration History 是一个 Jenkins 插件，用于跟踪和记录 Jenkins 作业配置的历史变更。该插件可以记录任何作业配置的修改，并提供比较不同版本配置的功能，帮助管理员和开发人员追踪配置变更、恢复误操作以及审计配置修改历史。
- 自动记录所有作业配置的变更历史
- 提供详细的配置变更记录，包括修改时间、修改用户和变更内容
- 支持比较不同版本的配置差异
- 允许恢复到之前的配置版本
- 可以查看系统配置和全局配置的变更历史
- 支持配置历史的保留策略，避免占用过多磁盘空间
1.2 插件安装
- 官方地址： https://plugins.jenkins.io/jobConfigHistory/
- 安装方式： 系统管理 -> 管理插件 -> 可选插件 ->
Job Configuration History-> 直接安装
1.3 基本配置
1.3.1 插件全局配置
安装插件后，可以在系统管理中找到 Job Configuration History 的配置选项：
- 进入 系统管理 -> 系统配置
- 找到 "Job Configuration History" 部分
- 配置以下选项：
- 历史文件存储路径（默认为
$JENKINS_HOME/config-history） - 最大历史条目数（限制每个作业保存的历史版本数量）
- 历史保留天数（超过指定天数的历史记录将被自动删除）
- 是否跳过重复的历史记录（避免保存相同的配置）
- 是否在系统日志中记录配置变更
- 历史文件存储路径（默认为
1.4 使用方法
1.4.1 查看作业配置历史
查看特定作业的配置历史有两种方式：
方式一：通过作业页面访问
- 进入要查看的作业页面
- 在左侧菜单中点击 "Job Config History" 链接
- 系统将显示该作业的所有配置变更历史
方式二：通过系统管理页面访问
- 进入 系统管理 -> Job Config History
- 在页面上可以查看所有作业的配置变更历史
- 使用过滤选项可以按作业名称、用户名或日期范围筛选历史记录
1.4.2 比较配置差异
Job Configuration History 插件提供了强大的配置比较功能：
- 在配置历史列表中，选择两个版本
- 点击 "Compare" 按钮
- 系统将以并排或合并视图显示两个版本之间的差异
- 差异部分会以不同颜色高亮显示（添加的内容为绿色，删除的内容为红色）
1.4.3 恢复历史配置
当发现配置错误或需要回滚到之前版本时，可以使用恢复功能：
- 在配置历史列表中，找到要恢复的版本
- 点击该版本对应的 "Restore" 按钮
- 确认恢复操作
- 系统将把作业配置恢复到选定的历史版本
WARNING
恢复操作会创建一个新的配置版本，而不是删除之后的变更历史。这意味着您随时可以再次查看或恢复其他版本。
1.5 高级功能
1.5.1 查看系统配置历史
除了作业配置外，Job Configuration History 插件还可以跟踪系统配置的变更：
- 进入 系统管理 -> Job Config History
- 点击 "System Configuration History" 标签
- 查看系统配置的变更历史，包括全局工具配置、安全设置等
1.5.2 查看删除的作业配置
插件还可以保留已删除作业的配置历史：
- 进入 系统管理 -> Job Config History
- 点击 "Deleted Jobs" 标签
- 查看已删除作业的最后配置版本
- 可以查看配置详情，甚至可以通过配置内容重新创建作业
1.5.3 配置历史的 API 访问
Job Configuration History 插件提供了 REST API，可以通过程序访问配置历史：
- 获取所有历史记录：
/jobConfigHistory/api/xml或/jobConfigHistory/api/json - 获取特定作业的历史：
/job/{jobName}/jobConfigHistory/api/xml或/job/{jobName}/jobConfigHistory/api/json - 获取系统配置历史：
/jobConfigHistory/api/xml?type=system或/jobConfigHistory/api/json?type=system
这些 API 可以与其他自动化工具集成，用于监控配置变更或创建自定义报告。