有些项目的构建需要动态的传入一些参数,比如需要用户输入一些内容,或者上传一个文件,或者为一些配置打钩,作为不同的参数,当构建时这些参数作为环境变量来影响具体的构建过程。
比如,我们知道sh "printenv"
会打印所有的环境变量方便调试,但是如果写死在pipeline里,每次构建 console output都会输出大量内容。 比如现在
stage('debug') { steps { sh "printenv" }}
我希望构建时可以手动控制是否输出调试信息。默认为关闭,即不输出,打钩后才输出信息。
下面的例子就讲解如何实现
当我们新建的项目为freestyle或pipeline类型,在配置页面的General的tab中会发现有一个选项为 "This project is parameterized" 表示该项目类型为可参数化的,勾选之后,可以添加很多类型的参数,如下图
比如我这里添加一个Boolean Parameter,参数名称为is_print_env,默认不显示环境变量信息,即不希望执行sh "printenv"
修改之前的pipeline,根据is_print_env的取值走不同的逻辑。
pipeline { agent any stages { stage('debug') { steps { // echo env.is_print_env script { if (env.is_print_env) { sh "printenv" } else { echo "no execute 'sh printenv'" } } } } } }
保存之后来到该项目的首页,左侧功能列表中会发现之前的"Build now"变为了"Build with parameters"。点击后,刚才的Boolean Parameter参数配置就可视化了。
Pipeline Parameter
上面的参数是在页面上手动添加,实际上如果是pipeline类型的job,可以用代码的方式是实现,这样更灵活,更容易版本化管理 pipeline语法支持传入parameters指令,parameter 包括 string, text(多行文本), boolean, choice(下拉),file 文件类型(很少用), password(密码类型)等。
pipeline { agent any parameters { booleanParam(defaultValue: true, description: '', name: 'p_userFlag') choice( choices: 'dev\nprod', description: 'choose deploy environment', name: 'p_deploy_env' ) string (name: 'p_version', defaultValue: '1.0.0', description: 'build version') text (name: 'p_deploy_text', defaultValue: 'One\nTwo\nThree', description: '') password (name: 'p_password', defaultValue: '', description: '') }}
UI自动生成代码: 项目地址/directive-generator/
发表评论