使用load加载流水线块是否属于有效Jenkins声明式流水线？如何正确实现？

场景与现有代码 #

我有两个Jenkins任务，它们对应的Jenkinsfile几乎完全相同，因此希望将Jenkinsfile抽象为通用文件。相关代码如下：

commonPipeline.groovy #

def buildImage(imageName) {
  pipeline {
    agent any
    stages {
      stage('Build Image') {
        steps {
          script {
            sh "${imageName}/build_image.sh"
          }
        }
      }
    }
  }
}

return this

Jenkinsfile_foo #

commonPipeline = load 'commonPipeline.groovy'
commonPipeline.buildImage('foo')

问题解答 #

1. 使用load步骤加载流水线块是否仍属于声明式Jenkins流水线？ #

使用load步骤加载包含完整pipeline块的脚本，不属于声明式流水线的规范用法。

声明式流水线的核心要求是：整个流水线的顶层结构必须是直接定义在Jenkinsfile中的pipeline块，这是声明式语法的唯一入口。load本质是脚本式流水线的特性，虽然可以在声明式的script块中调用，但如果外部脚本返回的是完整的pipeline块，会打破声明式的结构约束，此时流水线会退化为脚本式的执行逻辑。

2. Jenkinsfile_foo是否为有效的Jenkins声明式流水线？若无效，正确实现方式是什么？ #

Jenkinsfile_foo不是有效的声明式流水线。

因为声明式流水线要求Jenkinsfile的顶层必须是pipeline块，而当前的Jenkinsfile_foo顶层是脚本式的变量赋值与函数调用，完全不符合声明式的语法结构。

正确实现方式

要在声明式流水线中实现代码复用，应该抽象公共的阶段/步骤逻辑，而非整个pipeline块，具体如下：

1. 调整公共脚本（commonPipeline.groovy）

只封装可复用的阶段逻辑，不包含完整pipeline块：

// commonPipeline.groovy
def buildImageStage(String imageName) {
  stage('Build Image') {
    steps {
      sh "${imageName}/build_image.sh"
    }
  }
}

return this

2. 修正具体Jenkinsfile（Jenkinsfile_foo）

保持顶层为声明式pipeline块，在stages内通过script块调用公共逻辑：

// Jenkinsfile_foo
def commonPipeline = load 'commonPipeline.groovy'

pipeline {
  agent any
  stages {
    script {
      commonPipeline.buildImageStage('foo')
    }
  }
}

如果团队有Jenkins共享库，更推荐将公共逻辑封装为共享库中的steps或stages，进一步提升复用性与规范性，但本地脚本的方式已能满足基础的复用需求。

内容的提问来源于stack exchange，提问作者Daniele Repici