企业微信Jenkins构建通知插件(Qy Wechat Notification)

企业微信Jenkins构建通知插件(Qy Wechat Notification)

qy-wechat-notification-plugin项目地址:https://gitcode.com/gh_mirrors/qy/qy-wechat-notification-plugin

项目介绍

Qy Wechat Notification是一款专为企业微信环境设计的Jenkins插件。它允许在Jenkins作业(包括Freestyle Job和Pipeline)完成后自动向预设的企业微信群发送通知，以及时告知团队成员构建结果和其他相关信息。

功能特性

• Freestyle Job支持: 在传统Jenkins作业结束后触发企业微信消息。
• Pipeline集成: 直接在Jenkins Pipeline定义文件中集成企业微信通知步骤。
• 自定义消息: 根据需要定制消息内容，包括提到特定用户或手机等。
• 失败通知: 当构建失败时，可以设置额外的消息来提醒指定责任人。
• 简易配置: 只需提供企业微信机器人的Webhook URL即可启用通知服务。

项目快速启动

为了快速启动并使用Qy Wechat Notification插件，您需要遵循以下步骤：

步骤1: 安装插件

访问您的Jenkins实例，在“系统管理”->“插件管理”中搜索并安装Qy Wechat Notification插件。

**注:** 如果已存在旧版插件，请先卸载再重新安装最新版本。

步骤2: 配置企业微信机器人

1. 创建一个新的群机器人(确保权限正确)，获取其Webhook URL。
2. 在Jenkins的全局配置或者具体Job的配置界面内找到Qy Wechat Notification配置部分。
3. 输入刚刚得到的Webhook URL，以及其他如需要提及的用户ID或手机等详细信息。

步骤3: 编写Jenkinsfile (对于Pipeline作业)

在你的Jenkinsfile中，可以在post阶段加入企业微信通知逻辑:

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                // 构建任务...
            }
        }
    }
    post {
        always {
            script {
                def msg = "构建结束: ${currentBuild.result}"
                if(currentBuild.result != 'SUCCESS') {
                    qyWechatNotification(
                        failNotify: true,
                        mentionedId: '需要通知UserID',
                        mentionedMobile: '需要通知的通知手机号码',
                        webhookUrl: '你的WebhookURL',
                        message: "${msg}\n详情: ${env.BUILD_URL}")
                } else {
                    qyWechatNotification(webhookUrl: '你的WebhookURL', message: msg)
                }
            }
        }
    }
}

将上述Groovy脚本中的你的WebhookURL替换为你实际获得的Webhook URL，需要通知UserID和需要通知的通知手机号码替换为实际接收者的信息。

应用案例和最佳实践

案例描述

假设在一个持续集成环境中，每当自动化测试通过后都需要立即通知开发人员进行后续的代码合并工作。利用Qy Wechat Notification插件可以设定一条规则——一旦测试用例全部通过，则通过企业微信发送“测试成功，等待代码合并”的消息给指定负责人或开发组，从而加速开发流程。

实践建议

• 故障检测: 设置在任何失败场景下的自动通知机制，减少响应时间。
• 自定义消息: 使用Jenkins内置变量和条件语句创建动态且具体化的消息模板。
• 监控与调试: 对通知请求的结果进行日志记录，便于追踪和故障排查。

典型生态项目

结合其他Jenkins插件或工具，Qy Wechat Notification能够成为更为全面和智能化的工作流组件之一。例如，与GitHub Plugin集成，实现在每次代码提交后对企业微信群发出通知；或是同Docker Pipeline Plugin结合，让容器化部署流程中的关键节点变化实时更新到企业微信。

总结而言，Qy Wechat Notification不仅简化了信息传播途径，更增强了团队协作效率与反馈机制，尤其适合于大型软件开发团队或追求高效自动化运维体系的组织。

qy-wechat-notification-plugin项目地址:https://gitcode.com/gh_mirrors/qy/qy-wechat-notification-plugin