Jenkins Pipeline语法(上)
Jenkins Pipeline语法(中)
Jenkins Pipeline语法(下)
顺序执行的stage(Sequential Stages)
声明性Pipeline中的stage
可以按顺序声明待运行的stage
列表。需要注意的是一个stage
有且只能有一个 steps
,parallel
或者stages
,stages
是顺序执行的。stage
内的stage无法进一步含有parallel
或stages
,但他们允许使用stage
的所有其他功能,包括 agent
,tools
,when
等等。
例
pipeline {
agent none
stages {
stage('Non-Sequential Stage') {
agent {
label 'for-non-sequential'
}
steps {
echo "On Non-Sequential Stage"
}
}
stage('Sequential') {
agent {
label 'for-sequential'
}
environment {
FOR_SEQUENTIAL = "some-value"
}
stages {
stage('In Sequential 1') {
steps {
echo "In Sequential 1"
}
}
stage('In Sequential 2') {
steps {
echo "In Sequential 2"
}
}
}
}
}
}
并行的stage(Parallel)
声明性Parallel中的stage
可以在parallel
块中声明多个嵌套stage,这些stage将并行执行。需要注意的是一个stage有且只能有一个steps
,stages
或parallel
。嵌套的stages本身不能包含其他parallel
stage,但在其他方面的行为与stage
相同,包括顺序执行的stage列表stages
。任何包含parallel
的stage都不能包含agent
或者tools
,因为那些和steps
没有关系。
此外,您可以通过添加failFast true
到包含parallel
的stage
中,使得其中一个失败时中止所有parallel
内的stage
。
例
pipeline {
agent any
stages {
stage('Non-Parallel Stage') {
steps {
echo 'This stage will be executed first.'
}
}
stage('Parallel Stage') {
when {
branch 'master'
}
failFast true
parallel {
stage('Branch A') {
agent {
label "for-branch-a"
}
steps {
echo "On Branch A"
}
}
stage('Branch B') {
agent {
label "for-branch-b"
}
steps {
echo "On Branch B"
}
}
stage('Branch C') {
agent {
label "for-branch-c"
}
stages {
stage('Nested 1') {
steps {
echo "In stage Nested 1 within Branch C"
}
}
stage('Nested 2') {
steps {
echo "In stage Nested 2 within Branch C"
}
}
}
}
}
}
}
}
步骤 Steps
声明性Pipeline可以使用“ Pipeline步骤”引用中记录的所有可用步骤 ,其中包含一个完整的步骤列表,并附加以下列出的步骤,仅在声明性Pipeline中支持。
脚本 script
script
步骤需要一个script Pipeline,并在声明性Pipeline中执行。对于大多数场景,声明Pipeline中的script
步骤不是必须的,但它可以提供一个有用的“escape hatch”。量大的或者复杂的script
块应该转移到共享库中。
例如:
Jenkinsfile (Declarative Pipeline)
pipeline {
agent any
stages {
stage('Example') {
steps {
echo 'Hello World'
script {
def browsers = ['chrome', 'firefox']
for (int i = 0; i < browsers.size(); ++i) {
echo "Testing the ${browsers[i]} browser"
}
}
}
}
}
}
Scripted Pipeline
Scripted Pipeline,如声明式Pipeline,构建在底层Pipeline子系统之上。不像声明式Pipeline,Scripted Pipeline是一个基于Groovy构建的,通用、高效的DSL。由Groovy语言提供的大多数功能都提供给Scripted Pipeline的用户,这意味着它是一个非常富有表现力和灵活性的工具,可以通过这些工具来创建持续构建的Pipeline。
Flow Control
Scripted Pipeline从顶部顺序执行,与Jenkinsfile Groovy或其他语言中的大多数传统Scripted一样。因此,提供流量控制取决于Groovy表达式,例如 if/else条件,例如:
Jenkinsfile (Scripted Pipeline)
node {
stage('Example') {
if (env.BRANCH_NAME == 'master') {
echo 'I only execute on the master branch'
} else {
echo 'I execute elsewhere'
}
}
}
可以管理Scripted Pipeline流控制的另一种方式是使用Groovy的异常处理支持。当步骤由于任何原因而导致异常时。处理错误行为必须使用Groovy 中的try/catch/finally
块,例如:
Jenkinsfile (Scripted Pipeline)
node {
stage('Example') {
try {
sh 'exit 1'
}
catch (exc) {
echo 'Something failed, I should sound the klaxons!'
throw
}
}
}
Steps
如“ 入门指南 ”所述,Pipeline最基本的部分是“步骤”。从根本上说,步骤告诉Jenkins 要做什么,并且作为Declarative和Scripted Pipeline语法的基本构建块。
Scripted Pipeline并没有介绍这是专门针对它的语法的任何步骤; Pipeline步骤参考 ,其中包含Pipeline和插件提供的完整步骤列表。
与Groovy的区别
为了提供持久性(运行中的Pipeline可以在重新启动Jenkins主站后保留),Scripted Pipeline必须将数据序列化到master节点。由于这个设计要求,一些Groovy语法如collection.each { item -> /* perform operation */ }
没有完全支持。有关 更多信息,请参见 JENKINS-27421和 JENKINS-26481。
语法比较
当Jenkins Pipeline首次创建时,Groovy被选为执行引擎。Jenkins已经使用嵌入式Groovy引擎很长时间,为管理员和用户提供高级脚本功能。此外,Jenkins Pipeline的实现者发现Groovy是建立“Scripted Pipeline”DSL的坚实基础。
由于它是一个功能齐全的编程环境,Scripted Pipeline为Jenkins用户提供了极大的灵活性和可扩展性。Groovy学习曲线通常不适用于给定团队的所有成员,因此,创建声明性Pipeline是为了创作Jenkins Pipeline提供一个更简单和更有见解的语法。
两者基本上是底层相同的Pipeline 子系统。它们都是“Pipeline代码”的持久实现。他们都能够使用Pipeline内置的插件或插件提供的步骤。两者都可以利用共享库
不同之处在于语法和灵活性。声明性限制了用户具有更严格和预定义结构的可用性,使其成为更简单连续输送Pipeline的理想选择。脚本化提供了极少的限制,因为Groovy本身只能对结构和语法进行限制,而不是任何Pipeline专用系统,使其成为高级用户和具有更复杂要求的用户的理想选择。顾名思义,Declarative Pipeline鼓励声明式编程模型。 尽管Scripted Pipeline遵循更命令性的编程模型。
- Jenkins Pipeline语法(上)
- Jenkins Pipeline语法(中)
- Jenkins Pipeline语法(下)