Jenkins2 学习系列8 -- 实战 使用 Generic
更新 2019-07-14
关于webhook触发job,其实有更简单的办法,在job的配置页面
勾选Build Triggers
选项卡的Trigger builds remotely (e.g., from scripts)
,填入一个token
image.png
比如job名称是foo,token是123456,webhook地址就是JENKINS_URL/job/=foo/build?token=123456
经测无论是get还是post请求都可以成功触发。当然如果你的需求更高,需要根据请求头请求或地址中的参数有条件的触发,就可以用Generic Webhook Trigger插件。
如果返回'Authentication required'请检查地址中的token是否正确,还需要保证在Jenkins的'Configure Global Security'配置页面勾选了'Allow anonymous read access'。
需求:我的博客是用hexo搭建的,每次提交完代码都需要在托管的服务器上执行手动发布命令
deploy.sh
git pull
npm install
hexo g # 生成静态文件
现在我需要Jenkins的Generic Webhook Trigger插件来帮我自动完成这些工作。
Generic Webhook Trigger 是 Jenkins 提供的一款插件,装好这个插件后会暴露出一个URL地址,格式如 JENKINS_URL/generic-webhook-trigger/invoke
。
我们往这个地址发请求,请求体或请求头带上要构建的job名称,分支名称等信息,这个插件可以正则提取出这些信息,当作变量进而触发构建。
大致流程如下图:
image.png
- 在Jenkins插件管理页面搜索该插件
image.png
- 安装之后新建一个item,类型选freestyle,pipeline都行,在 Build Trigger 选项卡中会看到多出了一项 "Generic Webhook Trigger",勾选之后多出了很多信息。这里只填写Token
image.png
- 这里我创建的是个Pipeline的job,pipeline script 就是调用
deploy.sh
。注意这里我的博客和Jenkins都部署在了同一台服务器上面。
pipeline {
agent any
// 避免 npm install 报权限问题
environment {
PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"
}
stages {
stage('build') {
steps {
sh 'node -v'
sh 'npm -v'
dir ("/var/www/www.mafeifan.com/") {
sh 'git pull'
sh 'npm install'
sh 'hexo g'
}
}
}
}
}
- 来到Gitee/Github,添加一个webhook地址,如果你的Jenkins地址是http://110.110.110.110:8080,job名称为gitee-hexo-blog-pipeline,那么根据规则,Generic Webhook Trigger的地址是
http://110.110.110.110:8080/generic-webhook-trigger/invoke?token=gitee-hexo-blog-pipeline
配置完成,点测试,看返回内容是否是成功的。
image.png
- 测试,我们修改代码内容,并且push,发现Jenkins果然自动触发了build。
image.png
- 如果我们需要限制分支,比如只有往develop上push代码才触发,
在 Build Triggers 选项卡中填写 Post content parameters 内容。
即将请求体中的ref内容提取出来赋给$ref
image.png
然后在 Optional filter 选项卡中填写要过滤的分支名称。 Expression 填写正则 ^(refs/heads/develop)$
, Text 可以填写变量 $ref
image.png
测试时候建议用Postman。触发地址 GWT 会告诉咱们,请求体可以在仓库托管平台获取,然后手动修改内容进行测试
image.png