基于Jenkins共享库的通用流水线多团队适配及参数传递问题

你碰到的这个限制确实很常见——Jenkins的parameters块只能放在pipeline或stage层级，没法直接在steps里的自定义方法中添加。不过我们可以通过几种灵活的方式绕开这个限制，既满足参数传递需求，又能保持通用流水线的复用性：

方案1：给通用流水线预留阶段参数配置入口 #

你可以修改commonPipeline.groovy，让它支持接收一个可选的stageParams参数，用来定义各个阶段需要的参数，然后在对应stage层级添加parameters块，再把参数传递给executeStage。

修改后的commonPipeline.groovy示例：

#!/usr/bin/env groovy
def call(sharedLibrary, svcName, buildCommands, stageParams = [:]) {
    pipeline {
        agent { ... }
        stages {
            stage('Compilation') {
                // 若当前阶段配置了参数，就添加parameters块
                if (stageParams.compilation) {
                    parameters stageParams.compilation
                }
                steps {
                    script {
                        // 将当前阶段的参数传递给executeStage
                        sharedLibrary.executeStage("compile", buildCommands['compileData'], params)
                    }
                }
            }
            ... other stages ...
        }
    }
}

对应的Jenkinsfile使用示例：

@Library('utils') _
def svcName = currentBuild.rawBuild.project.parent.displayName
def sharedLibrary = new pythonApps()
def buildCommands = [ compileData: "python compile.py" ]
// 定义编译阶段专属参数
def stageParams = [
    compilation: [
        string(name: 'BUILD_ENV', defaultValue: 'dev', description: '编译目标环境')
    ]
]
timestamps {
    commonPipeline(sharedLibrary, svcName, buildCommands, stageParams)
}

同时更新共享库的executeStage方法，让它支持接收参数：

// pythonApps类中的executeStage方法示例
def executeStage(stageName, command, stageParams) {
    echo "执行${stageName}阶段，使用参数: ${stageParams}"
    sh "${command} --env ${stageParams.BUILD_ENV}"
}

方案2：使用全局参数定义，直接在executeStage中引用 #

如果你的参数是整个流水线通用的，不需要针对单个阶段定制，可以直接在pipeline层级定义parameters，然后在executeStage方法中直接引用Jenkins的全局params变量。

修改commonPipeline.groovy：

#!/usr/bin/env groovy
def call(sharedLibrary, svcName, buildCommands, globalParams = []) {
    pipeline {
        agent { ... }
        // 添加全局参数
        parameters globalParams
        stages {
            stage('Compilation') {
                steps {
                    script {
                        // 直接传递全局params给executeStage
                        sharedLibrary.executeStage("compile", buildCommands['compileData'], params)
                    }
                }
            }
            ... other stages ...
        }
    }
}

Jenkinsfile使用示例：

@Library('utils') _
def svcName = currentBuild.rawBuild.project.parent.displayName
def sharedLibrary = new pythonApps()
def buildCommands = [ compileData: "python compile.py" ]
def globalParams = [
    string(name: 'BUILD_VERSION', defaultValue: '1.0.0', description: '构建版本号'),
    booleanParam(name: 'RUN_TESTS', defaultValue: true, description: '是否执行自动化测试')
]
timestamps {
    commonPipeline(sharedLibrary, svcName, buildCommands, globalParams)
}

这种方式的好处是参数全局可用，所有阶段的executeStage都能直接调用。

方案3：在共享库实例初始化时绑定参数 #

如果你的参数和共享库实例强相关，也可以在创建pythonApps实例的时候把参数传递进去，这样executeStage方法就可以直接使用实例内部的参数了。

Jenkinsfile示例：

@Library('utils') _
def svcName = currentBuild.rawBuild.project.parent.displayName
// 初始化共享库实例时传递参数
def sharedLibrary = new pythonApps([BUILD_ENV: 'prod', BUILD_VERSION: '2.0.0'])
def buildCommands = [ compileData: "python compile.py" ]
timestamps {
    commonPipeline(sharedLibrary, svcName, buildCommands)
}

共享库中pythonApps类示例：

class pythonApps {
    def stageParams
    // 构造方法接收参数并绑定到实例
    pythonApps(params = [:]) {
        this.stageParams = params
    }
    def executeStage(stageName, command) {
        echo "执行${stageName}阶段，使用参数: ${this.stageParams}"
        sh "${command} --env ${this.stageParams.BUILD_ENV} --version ${this.stageParams.BUILD_VERSION}"
    }
}

这种方式适合不同团队需要用不同参数定制共享库行为的场景。

以上几种方案都能解决你在executeStage中传递参数的问题，你可以根据团队的实际需求（阶段专属参数、全局参数还是实例绑定参数）选择最合适的方式。

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