如何在JenkinsFile声明式流水线的参数描述中使用自定义函数

问题根源 #

• 声明式流水线的parameters块会在流水线初始化预加载阶段完成解析，只有Groovy双引号包裹的字符串才支持变量插值，你之前使用单引号+错误的拼接语法，自然无法解析check_env变量
• 原代码同时存在字符串拼接、sh命令引号嵌套的语法错误

修正后的流水线代码 #

// 确保app_env函数、ENVS常量在此处已经完成定义/导入
def check_env = app_env(ENVS, env.JOB_NAME)

pipeline {
    agent { label 'master' }
    options {
        disableConcurrentBuilds()
        buildDiscarder(logRotator(numToKeepStr: '20'))
        timestamps()
    }
    parameters{
        // 用双引号包裹描述字符串，使用${变量名}格式做插值
        string(name: 'myVariable', defaultValue: "/", description: "Enter Path To App e.g / OR /dummy_path for ${check_env}" )
    }
    stages{
        stage('Running App') {
            agent {
                docker {
                    image 'myApp:latest'                
                }
            }
            steps{
                script{
                    // 修正引号嵌套问题，内部双引号加转义符
                    sh label: 'App', script: "echo \"App is running in ${check_env}\""
                }
            }
        }
    }
}

注意事项 #

• 确保app_env函数、ENVS常量都定义在pipeline块之前，如果app_env来自共享库，需要在流水线开头通过@Library注解完成导入，保证参数解析阶段可以正常访问
• Jenkins的Job参数配置存在缓存，第一次运行流水线后参数描述会被持久化到Job配置中，如果后续check_env的取值有变化，需要重新加载流水线（多分支项目可执行「扫描多分支流水线」，普通项目重新保存一次Job配置）才会更新描述展示

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