企业微信Jenkins构建通知插件(qy-wechat-notification)入门指南

企业微信Jenkins构建通知插件(qy-wechat-notification)入门指南

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

1. 项目目录结构及介绍

企业微信Jenkins构建通知插件(qy-wechat-notification)的主要目录结构及其用途概述如下:

src/main/

• src/main/java: 包含所有的Java源代码,这是插件的核心业务逻辑所在.
  • com.cloudbees.plugins.wechat: 主要包含与企业微信集成相关的类.
    • QyWechatMessageNotifier.java: 实现企业微信消息通知的核心类.
    • QyWechatPostBuildAction.java: 定义Jenkins构建后执行的动作以触发企业微信通知.

src/test/

• src/test/java: 包含单元测试代码,用于验证插件的行为符合预期.

Jenkinsfile

• 此文件允许开发人员创建和管理持续集成(CI)/持续部署(CD)流程.对于此插件而言,Jenkinsfile可以用来演示如何在实际的构建过程中使用它.

LICENSE

• 描述项目使用的许可证类型,通常是为了确保源代码的使用遵循特定的法律条款.

README.md

• 描述项目的整体目标,功能和基本设置步骤,帮助新手快速了解并开始使用该项目.

pom.xml

• Maven项目对象模型文件,包含了构建脚本和项目依赖关系,用于编译项目和管理第三方库的版本.

2. 项目的启动文件介绍

由于这是一个Jenkins插件,主要通过Jenkins平台本身加载和运行.然而,在开发环境中,为了调试目的,可能需要单独运行某些组件.

• Jenkinsfile:

  • Jenkinsfile是一种文本文件,定义了一个项目的整个CI/CD工作流.在这个场景中,它是用来展示如何将qy-wechat-notification插件集成到Jenkins流水线中的示例.

    pipeline {
        agent any
        stages {
            stage('Hello') {
                steps {
                    echo 'Hello World'
                }
            }
        }
        post{
            success{
                qyWechatNotification(
                    failNotify: true,
                    mentionedId: '需要通知的UserID',
                    mentionedMobile: '需要通知的手机号码',
                    webhookUrl: '企业微信Webhook URL'
                )
            }
        }
    }
    

3. 项目的配置文件介绍

qy-wechat-notification插件的配置不需要额外的配置文件,所有配置都通过Jenkins UI或者管道脚本(Jenkinsfile)来设定.

当使用Freestyle Job时,可以在“构建后操作”部分选择“企业微信通知”,在此界面提供以下参数:

• Webhook URL:

  • 这是由企业微信为你的应用提供的URL,以便向指定的企业微信应用程序发送消息.

• 提到的ID:

  • 指定应该被提醒的用户的企业微信ID.

• 提到的手机:

  • 指定接收通知的电话号码,如果有的话.

在Jenkins Pipeline Job中,配置则是在post阶段的success或failure动作中通过qyWechatNotification步骤传递参数.详情见上文的Jenkinsfile代码示例.

以上就是关于企业微信Jenkins构建通知插件的基本介绍和关键点概览,希望对您理解和使用这个插件有所帮助!

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