企业微信机器人Jenkins插件
-
必要的配置
- 配置说明：参考文档
-
调用说明
- 函数：wxwork()
- 参数：
- robot：字符串，机器人ID，在 jenkins 系统配置中配置的企业微信机器人ID
- type：字符串，企业微信消息类型，可选值如下：
- text：文本消息
- markdown：markdown格式消息（简单markdown）
- markdown_v2：markdown_v2格式消息（复杂markdown）
- image：图片消息
- atMe：Boolean，消息是否"@"我自己(当前构建任务执行人)
- atAll：Boolean，消息是否"@"所有人
- at：Array：需要被"@"到的人的企业微信成员手机号列表
- text：Array：消息内容数组
- imageUrl：字符串，当前项目图片文件的相对路径（只有
type为image时有效）
-
Jenkinsfile （脚本写法）
#!groovy
node {
stage('文本消息') {
wxwork(
robot: 'ID',
type: 'text',
atMe: true, // 是否"@"我自己(当前构建任务执行人)
atAll: false, // 是否"@"所有人
at: [ // 企业微信成员手机号列表
'mobile1', 'mobile2'
],
text: [
'hello',
'world',
"env: ${ENV_NAME}", // 使用环境变量
"params: ${params.name}", // 使用构建参数变量
"displayName: ${currentBuild.displayName}", // 使用全局变量
]
)
}
stage('Markdown消息') {
wxwork(
robot: 'ID',
type: 'markdown',
text: [
'# hello world',
'- ppppppppp',
'- ppppppppp',
'> content',
"env: ${ENV_NAME}", // 使用环境变量
"params: ${params.name}", // 使用构建参数变量
"displayName: ${currentBuild.displayName}", // 使用全局变量
]
)
}
stage('Markdown v2消息（复杂的markdown消息）') {
wxwork(
robot: 'ID',
type: 'markdown_v2',
text: [
"# 一、标题\n## 二级标题\n### 三级标题\n",
"# 二、字体\n*斜体*\n\n**加粗**\n",
"# 三、列表 \n- 无序列表 1 \n- 无序列表 2\n - 无序列表 2.1\n - 无序列表 2.2\n1. 有序列表 1\n2. 有序列表 2\n",
"# 四、引用\n> 一级引用\n>>二级引用\n>>>三级引用\n",
"# 五、链接\n [这是一个链接](https://work.weixin.qq.com/api/doc)\n \n",
"# 六、分割线\n\n---\n",
"# 七、代码\n`这是行内代码`\n```\n这是独立代码块\n```\n\n",
"# 八、表格\n| 姓名 | 文化衫尺寸 | 收货地址 |\n| :----- | :----: | -------: |\n| 张三 | S | 广州 |\n| 李四 | L | 深圳 |\n"
]
)
}
stage('图片消息') {
wxwork(
robot: 'ID',
type: 'image',
imageUrl: 'image.png' // 当前项目图片文件相对路径
)
}
}
- Jenkinsfile （声明式写法）
pipeline {
agent any
stages {
stage('Hello') {
steps {
echo 'Hello World'
// 发送消息
wxwork(
robot: 'test',
type: 'text',
text: [
"stage: Hello",
"displayName: ${currentBuild.displayName}",
"absoluteUrl: ${currentBuild.absoluteUrl}"
]
)
}
}
stage('build') {
steps {
script {
println "build number: ${currentBuild.number}";
println "current result: ${currentBuild.currentResult}";
println "build URL: ${currentBuild.absoluteUrl}";
// 发送消息
wxwork(
robot: 'test',
type: 'text',
text: [
"stage: build",
"displayName: ${currentBuild.displayName}",
"absoluteUrl: ${currentBuild.absoluteUrl}"
]
)
}
}
}
stage('some-stage') {
steps {
script {
println "build number: ${currentBuild.number} - some stage";
// err
sh "fsdfsdf"
// 发送消息
wxwork(
robot: 'test',
type: 'text',
text: [
"stage: some-stage",
"displayName: ${currentBuild.displayName}",
"absoluteUrl: ${currentBuild.absoluteUrl}"
]
)
}
}
}
}
post {
always {
// 无论什么情况都发送消息
wxwork(
robot: 'test',
type: 'text',
text: [
"post-always",
"displayName: ${currentBuild.displayName}",
"absoluteUrl: ${currentBuild.absoluteUrl}"
]
)
}
failure {
script {
// 状态异常
wxwork(
robot: 'test',
type: 'text',
text: [
"post-failure",
"displayName: ${currentBuild.displayName}",
"absoluteUrl: ${currentBuild.absoluteUrl}"
]
)
}
}
}
}
Licensed under MIT, see LICENSE