手把手教你使用 Jenkins 之 PipeLine 和触发器的使用
- Pipeline
- Pipeline 简介
- Pipeline 插件安装
- Pipeline 语法
- 创建 Pipeline 任务
- Pipeline Script from SCM
- 触发器
- Git hook自动触发构建
Pipeline
Pipeline 简介
1. 概念
Pipeline，简单来说，就是一套运行在 Jenkins 上的工作流框架，将原来独立运行于单个或者多个节点
的任务连接起来，实现单个任务难以完成的复杂流程编排和可视化的工作。
2. 使用 Pipeline 有以下好处
- 代码：Pipeline以代码的形式实现，通常被检入源代码控制，使团队能够编辑，审查和迭代其传送流程。
- 持久：无论是计划内的还是计划外的服务器重启，Pipeline都是可恢复的。
- 可停止：Pipeline可接收交互式输入，以确定是否继续执行Pipeline。
- 多功能：Pipeline支持现实世界中复杂的持续交付要求。它支持fork/join、循环执行，并行执行任务的功能。
- 可扩展：Pipeline插件支持其DSL的自定义扩展 ，以及与其他插件集成的多个选项。
3. 如何创建 Jenkins Pipeline
- Pipeline 脚本是由 Groovy 语言实现的，但是我们没必要单独去学习 Groovy
- Pipeline 支持两种语法：Declarative(声明式)和 Scripted Pipeline(脚本式)语法
- Pipeline 也有两种创建方法：可以直接在 Jenkins 的 Web UI 界面中输入脚本；也可以通过创建一个 Jenkinsfile 脚本文件放入项源码库中（一般我们都推荐在 Jenkins 中直接从源代码控制(SCM)中直接载入 Jenkinsfile Pipeline 这种方法）
Pipeline 插件安装
Pipeline 语法
Declarative声明式-Pipeline
- pipeline：代表整条流水线，包含整条流水线的逻辑
- stages：代表整个流水线的所有执行阶段。通常stages只有1个，里面包含多个stage。
- stage：代表流水线中的某个阶段，可能出现n个。一般分为拉取代码，编译构建，部署等阶段。
- steps：代表一个阶段内需要执行的逻辑。steps里面是shell脚本，git拉取代码，ssh远程发布等任意内
容。 - agent：指定流水线的执行位置（Jenkins agent）。流水线中的每个每段都必须在某个地方（物理机、虚拟机或Docker 容器）执行。agent部分即指定具体在哪里执行。
以上的每一项都是必需的，少任何一个，Jenkins 都会报错。
编写一个简单声明式Pipeline：
pipeline {
agent any
stages {
stage('Build') {
steps {
echo 'Building..'
}
}
stage('Test') {
steps {
echo 'Testing..'
}
}
stage('Deploy') {
steps {
echo 'Deploying....'
}
}
}
}Scripted Pipeline脚本式-Pipeline
- Node：节点，一个 Node 就是一个 Jenkins 节点，Master 或者 Agent，是执行 Step 的具体运行环境，后续讲到Jenkins的Master-Slave架构的时候用到。
- Stage：阶段，一个 Pipeline 可以划分为若干个 Stage，每个 Stage 代表一组操作，比如：Build、Test、Deploy，Stage 是一个逻辑分组的概念。
- Step：步骤，Step 是最基本的操作单元，可以是打印一句话，也可以是构建一个 Docker 镜像，由各类 Jenkins 插件提供，比如命令：sh ‘make’，就相当于我们平时 shell 终端中执行 make 命令一样。
编写一个简单脚本式Pipeline：
node {
def mvnHome
stage('Preparation') { // for display purposes
// Get some code from a GitHub repository
git 'https://github.com/jglick/simple-maven-project-with-tests.git'
// Get the Maven tool.
// ** NOTE: This 'M3' Maven tool must be configured
// ** in the global configuration.
mvnHome = tool 'M3'
}
stage('Build') {
// Run the maven build
withEnv(["MVN_HOME=$mvnHome"]) {
if (isUnix()) {
sh '"$MVN_HOME/bin/mvn" -Dmaven.test.failure.ignore clean package'
} else {
bat(/"%MVN_HOME%\bin\mvn" -Dmaven.test.failure.ignore clean package/)
}
}
}
stage('Results') {
junit '**/target/surefire-reports/TEST-*.xml'
archiveArtifacts 'target/*.jar'
}
}创建 Pipeline 任务
通过片段生成器拉取代码：
将生成的脚本复制到pull code步骤中：
使用 shell 脚本构建项目：
生成部署脚本，应用并保存：
构建项目并查看构建结果：
Pipeline Script from SCM
刚才我们都是直接在Jenkins的UI界面编写Pipeline代码，这样不方便脚本维护，建议把Pipeline脚本放
在项目中（一起进行版本控制）。
1. 在项目根目录建立Jenkinsfile文件，把内容复制到该文件中，并将文件推送到远程仓库
2. 在 Jenkins 中配置该脚本
触发器
Jenkins内置4种构建触发器：
- 触发远程构建
- 其他工程构建后触发（Build after other projects are build）
- 定时构建（Build periodically）
- 轮询SCM（Poll SCM）
Git hook自动触发构建
轮询SCM可以实现Gitlab代码更新，项目自动构建，但是该方案的性能不佳。那有没有更好的方案呢？有的。就是利用webhook实现代码push到仓库，立即触发项目自动构建。
1. 安装webhook插件
在Jenkins上安装webhook插件，使用Github就安装Github插件，使用Gitee就安装Gitee插件，以此类推，也可以安装Generic Webhook Trigger这种通用的webhook插件。
下面以Gitee为例，安装Gitee插件。
2. Jenkins 构建触发器
在项目配置中构建触发器中选择Gitee webhook，复制 Jenkins 生成的URL和密码，应用并保存。
注意：使用Github，Gitee这些公有仓库时，需要jenkins服务器有公网IP，这样Jenkins才能接收到仓库发送的请求。
2. 在Gitee中填入URL和密码
进入源码管理配置中设置的Gitee项目中，进入 管理 -> WebHooks，添加 WebHook，填写上一步复制的URL和密码，不设密码可以不填密码，勾选 PUSH， Pull Request。
3. 测试推送触发构建
Gitee项目页面编辑一个文件提交，观察 Jenkins 任务的构建状态。
