Jenkins+Gitlab+Generic Webhook Trigger插件

桃扇骨 2024-04-18 12:35 70阅读 0赞

#### 目标： ####

1、Git被提交代码到对应分支，Jenkins对应的分支触发构建  
（原来的方法是设定每分钟轮询的，这种方法能用但是不好）。  
2、使用Pipeline脚本

#### 方法： ####

使用Jenkins插件Generic Webhook Trigger，将Jenkins和Gitlab配合起来。

#### 步骤： ####

1、Jenkins插件中心安装插件 `Generic Webhook Trigger`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70]  
2、设置API Token  
Jenkins》系统管理》管理用户》修改用户信息》API Token》添加 Token》  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1]  
点击 “生成” 按钮后，然后记录下token串，然后底下保存。

3、配置Gitlab Hook  
登录Gitlab进入某个项目》Settings》Integrations》Add webhook  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 2]  
然后保存，下面可以手工触发进行测试。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 3]  
当点击触发事件的时候，Jenkins 就会收到来自 Gitlab 的请求。  
如下是我基于 Jenkins Pipeline 的关键脚本片段：

//省略代码若干//
        properties([
          disableConcurrentBuilds(), // 这行与本例无关
          buildDiscarder(logRotator(artifactDaysToKeepStr: '', artifactNumToKeepStr: '', daysToKeepStr: '1', numToKeepStr: '3')), // 这行与本例无关
          pipelineTriggers([
           [$class: 'GenericTrigger',
            genericVariables: [
             [
              key: 'ref', 
              value: '$.ref'
             ],
             [
              key: 'before',
              value: '$.before',
              expressionType: 'JSONPath', //Optional, defaults to JSONPath
              regexpFilter: '', //Optional, defaults to empty string
              defaultValue: '' //Optional, defaults to empty string
             ],
             [
              key: 'after',
              value: '$.after',
              expressionType: 'JSONPath', //Optional, defaults to JSONPath
              regexpFilter: '', //Optional, defaults to empty string
              defaultValue: '' //Optional, defaults to empty string
             ],
             [
              key: 'projectName',
              value: '$.project.name',
              expressionType: 'JSONPath', //Optional, defaults to JSONPath
              regexpFilter: '', //Optional, defaults to empty string
              defaultValue: '' //Optional, defaults to empty string
             ]
            ],         
            causeString: 'Triggered on $projectName > $ref',
            
            //token: 'jenkins-token',// webhook触发端将token追加到请求后（放header中也可以）示例：http://admin:11c343cd5f00421@192.168.1.163:9999/generic-webhook-trigger/invoke?token=goodcol-jenkins
            
            printContributedVariables: true,
            printPostContent: true,        
            silentResponse: false,
            regexpFilterText: '$ref',
            regexpFilterExpression: 'refs/heads/' + BRANCH_NAME
           ]
          ])
        ])
    //省略代码若干//

PS：  
1、如果你不是Gitlab，这个也很简单，你写个简单的程序，暴露一个 invoke 连接，然后上面配置的地址配置成自己的 invoke 地址。然后进行触发测试，你可以debug 看收到的报文内容。然后根据内容调整上面代码中的key和value识别即可。当然你也可以写一个普通程序，调用这个接口来触发构建。  
所以，理论上这个触发的接口扩展性不错。  
2、使用Jenkinsfile的Pipeline脚本来构建项目，如果你脚本内容修改了，你需要执行一次构建，才会生效新的 properties，如果你改的是脚本中的其他命令内容，则不需要。

--------------------

### 小坑： ###

**错误提示**

**很多朋友使用最新版本的gitlab做自动部署时，在增加web钩子那一步时会报错：**

Url is blocked: Requests to the local network are not allowed  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 4]

**解决方法：**

**这是因为新版的gitlab为了安全默认禁止了本地局域网地址调用web hook，我们在设置里允许就行，具体步骤如下：**

Settings》Network》Outbound requests》Expand》勾选 Allow requests to the local network from web hooks and services 或者文本域中添加白名单》Save Changes  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 5]  
插件官方地址： https://plugins.jenkins.io/generic-webhook-trigger

（END）

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/fc72710c633e4b71978a34a94a03caa7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/62e5da84bbcd4b80902b6b7c7076bde8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/06341142a7bb4f1399e237011c4bb08d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/fbac93536f824d9888ddbe19c7e9afac.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/1aa3420e8ea24e0a9f725cfe6eb9f6a3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9zaGFuaHkuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/726bb41dd4514345b05f1964fe314310.png