Skip to content

FreeStyle 项目

FreeStyle 项目通过 Jenkins UI 配置通知,无需编写脚本。插件提供两种集成方式:

方式触发时机适用场景
Build Step(构建步骤)构建过程中,在指定步骤位置执行构建开始通知、阶段进度播报
Post-build Action(构建后操作)构建结束后,按结果条件触发成功、失败、不稳定、恢复通知

Build Step(构建步骤)

路径:项目配置 -> 构建步骤 -> 增加构建步骤 -> 发送企业微信通知

Build Step 基础配置

Build Step 高级配置

字段说明

字段说明
机器人选择系统配置中的机器人
消息类型text / markdown / markdown_v2 / image
内容消息正文,支持 Jenkins 环境变量与构建参数
@ 构建执行人勾选后 @ 触发本次构建的用户
@ 所有人勾选后 @ 群内所有成员,建议谨慎使用
@ 用户(手机号)逗号分隔的手机号列表,例如 13800000000,13900000000
图片地址image 类型生效,支持变量展开

适用说明

  • 适合在构建开始、编译完成、测试完成等中间阶段发送消息
  • 如果消息类型为 image,通常只需要填写图片地址
  • 文本类消息可直接引用 Jenkins 变量,例如 ${JOB_NAME}${BUILD_NUMBER}

Post-build Action(构建后操作)

路径:项目配置 -> 构建后操作 -> 增加构建后操作步骤 -> 发送企业微信通知

Post-build Action 基础配置

Post-build Action 消息内容配置

通知时机

时机触发条件
成功时通知构建结果为 SUCCESS
失败时通知构建结果为 FAILURE
不稳定时通知构建结果为 UNSTABLE
恢复时通知上次构建失败或不稳定,本次构建成功

勾选某个通知时机后,对应消息内容输入框才会显示。

恢复通知与成功通知的关系

两者是独立条件,可按需组合:

勾选情况效果
仅勾选“成功时通知”每次成功都发送成功消息
仅勾选“恢复时通知”仅在故障恢复时发送
同时勾选两者恢复时优先发送恢复消息,其余成功发送成功消息

恢复消息留空时,会自动回退使用成功消息内容。

FreeStyle 字段对照

字段Build StepPost-build Action说明
机器人使用系统配置中的预设机器人
消息类型text / markdown / markdown_v2 / image
内容-构建过程中发送的消息内容
成功消息-构建成功时发送
失败消息-构建失败时发送
不稳定消息-构建不稳定时发送
恢复消息-恢复时发送,留空则回退到成功消息
@ 构建执行人@ 当前构建执行人
@ 所有人@ 群内所有成员
@ 用户(手机号)逗号分隔手机号列表
图片地址image 类型生效

常用环境变量

text
${JOB_NAME}      项目名称
${BUILD_NUMBER}  构建编号
${BUILD_URL}     构建详情链接
${NODE_NAME}     构建节点名称
${GIT_BRANCH}    Git 分支(需 Git 插件)
${GIT_COMMIT}    Git 提交 SHA(需 Git 插件)

使用建议

  • 需要阶段性提示时优先使用 Build Step
  • 需要按结果发送总结通知时优先使用 Post-build Action
  • 如果页面中变量显示为占位符文本,这是正常现象,变量会在构建运行时再展开

基于 MIT License 开源。