Jenkinsfile使用手册

创建 Jenkinsfile

创建一个检入到源码管理系统中 [1] 的 Jenkinsfile 带来了一些直接的好处&＃xff1a;

• 流水线上的代码评审/迭代
• 对流水线进行审计跟踪
• 流水线的单一可信数据源 &＃xff0c;能够被项目的多个成员查看和编辑。

Jenkinsfile 是一个文本文件&＃xff0c;它包含了 Jenkins 流水线的定义并被检入源代码控制仓库。下面的流水线实现了基本的三阶段持续交付流水线。

pipeline {agent anystages {stage(&＃39;Build&＃39;) {steps {echo &＃39;Building..&＃39;}}stage(&＃39;Test&＃39;) {steps {echo &＃39;Testing..&＃39;}}stage(&＃39;Deploy&＃39;) {steps {echo &＃39;Deploying....&＃39;}}}
}


上面的声明式流水线示例包含了实现持续交付流水线的最小必要结构。agent指令是必需的&＃xff0c;它指示 Jenkins 为流水线分配一个执行器和工作区。没有 agent 指令的话&＃xff0c;声明式流水线不仅无效&＃xff0c;它也不可能完成任何工作&＃xff01;默认情况下&＃xff0c;agent 指令确保源代码仓库被检出并在后续阶段的步骤中可被使用。

构建

对于许多项目来说&＃xff0c;流水线“工作”的开始就是“构建”阶段。通常流水线的这个阶段包括源代码的组装、编译或打包。Jenkinsfile 文件不能替代现有的构建工具&＃xff0c;如 GNU/Make、Maven、Gradle 等&＃xff0c;而应视其为一个将项目的开发生命周期的多个阶段&＃xff08;构建、测试、部署等&＃xff09;绑定在一起的粘合层。

Jenkins 有许多插件可以用于调用几乎所有常用的构建工具&＃xff0c;不过这个例子只是从 shell 步骤&＃xff08;sh&＃xff09;调用 make。sh 步骤假设系统是基于 Unix/Linux 的&＃xff0c;对于基于 Windows 的系统可以使用 bat 替代。

pipeline {agent anystages {stage(&＃39;Build&＃39;) {steps {sh &＃39;make&＃39; archiveArtifacts artifacts: &＃39;**/target/*.jar&＃39;, fingerprint: true }}}
}


sh 步骤调用 make 命令&＃xff0c;只有命令返回的状态码为零时才会继续。任何非零的返回码都将使流水线失败。
archiveArtifacts 捕获符合模式&＃xff08;**/target/*.jar&＃xff09;匹配的交付件并将其保存到 Jenkins master 节点以供后续获取。

测试

运行自动化测试是任何成功的持续交付过程的重要组成部分。因此&＃xff0c;Jenkins 有许多测试记录&＃xff0c;报告和可视化工具&＃xff0c;这些都是由各种插件提供的。最基本的&＃xff0c;当测试失败时&＃xff0c;让 Jenkins 记录这些失败以供汇报以及在 web UI 中可视化是很有用的。下面的例子使用由 JUnit 插件提供的 junit 步骤。

在下面的例子中&＃xff0c;如果测试失败&＃xff0c;流水线就会被标记为“不稳定”&＃xff0c;这通过 web UI 中的黄色球表示。基于测试报告的记录&＃xff0c;Jenkins 还可以提供历史趋势分析和可视化。

pipeline {agent anystages {stage(&＃39;Test&＃39;) {steps {/* &＃96;make check&＃96; 在测试失败后返回非零的退出码&＃xff1b;* 使用 &＃96;true&＃96; 允许流水线继续进行*/sh &＃39;make check || true&＃39; junit &＃39;**/target/*.xml&＃39; }}}
}


使用内联的 shell 条件&＃xff08;sh ‘make || true’&＃xff09;确保 sh 步骤总是看到退出码是零&＃xff0c;使 junit 步骤有机会捕获和处理测试报告。在下面处理故障一节中&＃xff0c;对它的替代方法有更详细的介绍。
junit 捕获并关联与包含模式&＃xff08;*/target/.xml&＃xff09;匹配的 JUnit XML 文件。

部署

部署可以隐含许多步骤&＃xff0c;这取决于项目或组织的要求&＃xff0c;并且可能是从发布构建的交付件到 Artifactory 服务器&＃xff0c;到将代码推送到生产系统的任何东西。 在示例流水线的这个阶段&＃xff0c;“Build&＃xff08;构建&＃xff09;” 和 “Test&＃xff08;测试&＃xff09;” 阶段都已成功执行。从本质上讲&＃xff0c;“Deploy&＃xff08;部署&＃xff09;” 阶段只有在之前的阶段都成功完成后才会进行&＃xff0c;否则流水线会提前退出。

pipeline {agent anystages {stage(&＃39;Deploy&＃39;) {when {expression {currentBuild.result &＃61;&＃61; null || currentBuild.result &＃61;&＃61; &＃39;SUCCESS&＃39; }}steps {sh &＃39;make publish&＃39;}}}
}


流水线访问 currentBuild.result 变量确定是否有任何测试的失败。在这种情况下&＃xff0c;值为 UNSTABLE。


使用 Jenkinsfile 工作

字符串插值

def singlyQuoted &＃61; &＃39;Hello&＃39;
def doublyQuoted &＃61; "World"


def username &＃61; &＃39;Jenkins&＃39;
echo &＃39;Hello Mr. ${username}&＃39;
echo "I said, Hello Mr. ${username}"


其结果是&＃xff1a;

Hello Mr. ${username}
I said, Hello Mr. Jenkins

使用环境变量官方

pipeline {agent anystages {stage(&＃39;Example&＃39;) {steps {echo "Running ${env.BUILD_ID} on ${env.JENKINS_URL}"}}}
}


设置环境变量官方

pipeline {agent anyenvironment { CC &＃61; &＃39;clang&＃39;}stages {stage(&＃39;Example&＃39;) {environment { DEBUG_FLAGS &＃61; &＃39;-g&＃39;}steps {sh &＃39;printenv&＃39;}}}
}


动态设置环境变量官方

pipeline {agent any environment {// 使用 returnStdoutCC &＃61; """${sh(returnStdout: true,script: &＃39;echo "clang"&＃39;)}""" // 使用 returnStatusEXIT_STATUS &＃61; """${sh(returnStatus: true,script: &＃39;exit 1&＃39;)}"""}stages {stage(&＃39;Example&＃39;) {environment {DEBUG_FLAGS &＃61; &＃39;-g&＃39;}steps {sh &＃39;printenv&＃39;}}}
}


处理凭据官方

pipeline {agent {// 此处定义 agent 的细节}environment {AWS_ACCESS_KEY_ID &＃61; credentials(&＃39;jenkins-aws-secret-key-id&＃39;)AWS_SECRET_ACCESS_KEY &＃61; credentials(&＃39;jenkins-aws-secret-access-key&＃39;)}stages {stage(&＃39;Example stage 1&＃39;) {steps {// }}stage(&＃39;Example stage 2&＃39;) {steps {// }}}
}


处理参数官方

pipeline {agent anyparameters {string(name: &＃39;Greeting&＃39;, defaultValue: &＃39;Hello&＃39;, description: &＃39;How should I greet the world?&＃39;)}stages {stage(&＃39;Example&＃39;) {steps {echo "${params.Greeting} World!"}}}
}


处理故障官方