如何在Groovy编写的Jenkins Pipeline中访问stringParam类型参数

问题根因 #

出现该错误通常是以下3种常见原因：

1. 新增参数后未重新保存任务、触发新构建，直接重跑历史构建时，旧构建的上下文不存在该新增参数
2. parameters 块放置位置错误，声明式流水线中该块必须放在 pipeline 顶层，不能嵌套在stage、steps等子块中
3. 参数定义写在Jenkinsfile内时，首次运行Jenkins还未解析到参数配置，首次构建必然取不到值

正确使用示例 #

声明式流水线标准写法如下：

pipeline {
    agent any
    // parameters块必须放在pipeline顶层
    parameters {
        stringParam("COMMIT_SHA", "", "[Required] Short SHA of the commit used to build the image")
    }
    stages {
        stage("测试参数读取") {
            steps {
                // 推荐写法：优先从params对象取参数
                echo "The commit sha val is: ${params.COMMIT_SHA}"
                // 也可从环境变量读取
                echo "The commit sha val is: ${env.COMMIT_SHA}"
                script {
                    // 脚本块内可直接读取
                    echo "The commit sha val is: ${COMMIT_SHA}"
                }
            }
        }
    }
}

排查步骤 #

• 确认参数配置保存后，新触发一次构建，不要复用历史构建记录重跑
• 进入Jenkins任务的「参数」配置页，确认COMMIT_SHA已存在，拼写完全匹配（Jenkins参数大小写敏感）
• 若参数写在Jenkinsfile中，首次运行忽略报错，构建完成后Jenkins会自动加载参数定义，第二次运行即可正常取值
• 临时添加println params语句打印全量参数对象，确认COMMIT_SHA是否存在于参数列表中

内容的提问来源于stack exchange，提问作者prabhakar Reddy G