CI/CD / 系统课时

让参数决定不同执行路径

让参数决定不同执行路径

同一条 Jenkins 流水线经常既要支持普通构建,也要支持按环境部署。与其复制多份 Jenkinsfile,不如把会变化的输入定义为参数,再由流水线根据参数决定行为。本节用字符串、布尔和选项参数组织一条可复用的 Declarative Pipeline。

学习目标

  • 定义字符串、布尔和选项三类常用构建参数
  • 在流水线步骤中安全读取 params 参数值
  • 根据参数组合控制构建与部署路径

把变化的输入变成参数

Declarative Pipeline 可以在 parameters 中声明参数。字符串适合版本号等自由输入;布尔参数适合开启或关闭某项行为;选项参数适合环境这类值域固定的输入。

下面是一份可直接保存为 Jenkinsfile 的主示例。它始终执行构建,但只有勾选部署开关时才进入部署阶段,并根据目标环境输出对应行为。

groovy
pipeline {
    agent any

    parameters {
        string(name: 'IMAGE_TAG', defaultValue: 'latest', description: '待构建的镜像标签')
        booleanParam(name: 'DEPLOY', defaultValue: false, description: '构建完成后是否部署')
        choice(name: 'TARGET_ENV', choices: ['dev', 'staging', 'prod'], description: '目标环境')
    }

    stages {
        stage('Build') {
            steps {
                echo "Build image tag: ${params.IMAGE_TAG}"
            }
        }

        stage('Deploy') {
            when {
                expression { params.DEPLOY }
            }
            steps {
                echo "Deploy ${params.IMAGE_TAG} to ${params.TARGET_ENV}"
            }
        }
    }
}

预期输出:以 IMAGE_TAG=1.8.0、DEPLOY=true、TARGET_ENV=staging 触发构建时,关键控制台输出类似:

text
Build image tag: 1.8.0
Deploy 1.8.0 to staging

Jenkins 还会输出自身的阶段和执行日志,因此实际控制台内容会更多;这里仅列出示例中两条 echo 的确定结果。

从 params 读取参数

声明后的参数通过 params 对象读取,例如 params.IMAGE_TAG。不要把布尔参数当字符串比较:booleanParam 对应的是布尔值,因此应直接判断 params.DEPLOY,而不是判断它是否等于字符串 "true"。

参数也不等于环境变量。params.TARGET_ENV 表示本次构建输入,而 env 用于访问流水线环境变量。明确区分二者,可以避免 Jenkinsfile 中出现值来源不清的问题。

让参数决定路径而不是复制流程

参数化的重点不是增加输入框,而是把稳定流程和变化条件分开。构建、测试等公共阶段只定义一次,是否部署、部署哪个版本以及目标环境由参数决定。

参数驱动流水线执行路径

这种结构特别适合“构建总要执行、部署按需执行”的任务。如果生产发布还需要审批、权限或分支限制,不应只依赖一个 DEPLOY 布尔参数;参数负责表达用户意图,发布安全约束仍应由流水线条件和 Jenkins 权限机制共同保证。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

让参数决定不同执行路径

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通