企业微信Jenkins构建通知插件技术文档

企业微信Jenkins构建通知插件技术文档

1. 安装指南

1.1 环境要求

• Jenkins 2.303.1 或更高版本
• 企业微信 2.8.7 或更高版本

1.2 插件安装步骤

1. 打开Jenkins管理页面。
2. 导航到“系统管理” -> “插件管理”。
3. 在“可选插件”选项卡中，搜索“Qy Wechat Notification”。
4. 选择插件并点击“安装”按钮。
5. 安装完成后，重启Jenkins以使插件生效。

2. 项目的使用说明

2.1 添加群机器人

1. 在企业微信中，任意群成员可以通过右键群名称添加群机器人。
2. 企业微信会为新增加的群机器人分配一个Webhook地址，作为通知接口。

2.2 Freestyle Job配置

1. 在Jenkins项目底部的“构建后操作”中，添加“企业微信通知配置”。
2. 将Webhook地址信息输入Jenkins中，即可完成最简单配置。

2.3 Pipeline Job参考配置

pipeline {
    agent any

    stages {
        stage('Hello') {
            steps {
                echo 'Hello World'
            }
        }
    }
    post{
        success{
            qyWechatNotification failNotify: true, mentionedId: '需要通知UserID', mentionedMobile: '需要通知的通知手机号码', webhookUrl: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx-xxxxxx-xxxxxx', moreInfo:'额外的信息'
        }
        failure{
            qyWechatNotification failNotify: true, mentionedId: '需要通知UserID', mentionedMobile: '需要通知的通知手机号码', webhookUrl: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx-xxxxxx-xxxxxx', moreInfo:'额外的信息'
        }
    }
}

2.4 运行效果

• 构建开始时，群机器人会执行开始构建通知。
• 构建成功后，群机器人会执行构建成功的通知。
• 构建失败时，群机器人会执行失败的通知。

3. 项目API使用文档

3.1 API接口

• Webhook URL: https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx-xxxxxx-xxxxxx

3.2 参数说明

• failNotify: 是否在失败时通知。
• mentionedId: 需要通知的用户ID。
• mentionedMobile: 需要通知的手机号码。
• webhookUrl: Webhook地址。
• moreInfo: 额外的信息。

3.3 示例

qyWechatNotification failNotify: true, mentionedId: 'user123', mentionedMobile: '1234567890', webhookUrl: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx-xxxxxx-xxxxxx', moreInfo: '构建成功'

4. 项目安装方式

4.1 使用Maven进行开发

mvn org.jenkins-ci.tools:maven-hpi-plugin:run

4.2 打开Jenkins地址

http://127.0.0.1:8080/jenkins

4.3 项目DEBUG

set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n

4.4 项目打包

mvn package

5. 更多支持

如需更多支持，请通过以下地址进行留言： https://itwake.blog.csdn.net/article/details/122043499