Jenkinsfile 中处理不同分支的策略

1. 概述

在持续集成与持续交付（CI/CD）的实践中，Jenkinsfile 已成为开发者不可或缺的工具。它允许我们将整个 CI/CD 流水线以代码形式定义，从而实现流程的版本控制和灵活管理。

但随着项目复杂度的提升，我们常常需要在一个 Jenkinsfile 中处理多个分支的不同行为，这带来了一定的挑战。例如，main 分支可能需要部署到生产环境，而 feature 分支则只需进行基础测试。

本文将从基础到进阶，介绍几种在 Jenkinsfile 中处理不同分支的实用策略，帮助你写出更灵活、更高效的流水线脚本。

2. 理解分支专用流水线

要有效处理不同分支，首先需要理解“分支专用流水线”的概念，主要包括两个方面：

分支区分的重要性
常见的开发分支类型

2.1 分支区分的重要性

不同分支在开发流程中扮演不同角色，因此在 CI/CD 中的处理方式也应有所不同：

✅ main 分支通常代表生产就绪代码，需要严格的测试和部署流程
✅ develop 分支用于集成新功能，需全面测试但部署到预发布环境
✅ feature 分支用于开发新功能，通常只需快速构建和基础测试
✅ hotfix 分支用于紧急修复线上问题，应有快速但谨慎的流程

通过为不同分支定制流水线，我们可以：

优化资源使用，只运行必要的步骤
设置分支专属的质量门禁
自定义部署目标（如 staging 或 production）
调整通知机制，通知相关人员

2.2 常见分支类型

以下是开发流程中常见的分支类型：

分支类型	描述
main / master	生产就绪代码，需最严格的检查和部署流程
develop	集成分支，用于功能合并，需完整测试但部署到预发布环境
feature/*	功能开发分支，通常只需基础构建和测试
hotfix/*	紧急修复分支，需快速构建、测试并部署
release/*	发布准备分支，需完整测试和预生产部署

理解这些分支类型后，我们可以更有针对性地设计 Jenkinsfile。

3. 在 Jenkinsfile 中使用条件执行

条件执行是实现分支专用流水线的第一步，它允许我们根据当前构建的分支来决定执行哪些步骤。

3.1 使用 `when` 指令

Jenkins 提供了 when 指令，用于控制某个 stage 是否执行。例如：

pipeline {
    agent any
    stages {
        stage('Deploy to Production') {
            when {
                branch 'main'
            }
            steps {
                echo 'Deploying to production...'
                // 部署步骤
            }
        }
    }
}

上面的代码中，Deploy to Production 阶段仅在构建 main 分支时才会执行。

还可以使用组合条件：

when {
    anyOf {
        branch 'develop'
        branch 'staging'
    }
}

3.2 使用 `if-else` 判断语句

对于更复杂的逻辑，可以使用 Groovy 的 if-else 语句：

pipeline {
    agent any
    stages {
        stage('Build and Test') {
            steps {
                script {
                    if (env.BRANCH_NAME == 'main' || env.BRANCH_NAME == 'develop') {
                        echo 'Running full test suite...'
                        // 完整测试步骤
                    } else {
                        echo 'Running quick tests...'
                        // 快速测试步骤
                    }
                }
            }
        }
    }
}

还可以进一步嵌套判断，实现更灵活的控制：

script {
    if (env.BRANCH_NAME == 'main') {
        echo 'Deploying to production...'
    } else if (env.BRANCH_NAME == 'develop') {
        echo 'Deploying to staging...'
    } else {
        echo 'Skipping deployment'
    }
}

4. 使用环境变量识别分支

环境变量是识别分支和执行分支专属逻辑的另一种有效方式。

4.1 Jenkins 内置环境变量

Jenkins 提供了多个内置变量，其中 env.BRANCH_NAME 是最常用的：

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    echo "Building branch: ${env.BRANCH_NAME}"
                    if (env.BRANCH_NAME.startsWith('feature/')) {
                        echo "This is a feature branch"
                        // feature 分支构建逻辑
                    } else if (env.BRANCH_NAME == 'develop') {
                        echo "This is the develop branch"
                        // develop 分支构建逻辑
                    }
                }
            }
        }
    }
}

其他常用变量：

env.CHANGE_ID：用于识别 Pull Request
env.BUILD_NUMBER：当前构建编号
env.JOB_NAME：项目名称

4.2 自定义环境变量

除了内置变量，也可以定义自己的环境变量来简化逻辑：

pipeline {
    agent any
    environment {
        DEPLOY_TARGET = "${env.BRANCH_NAME == 'main' ? 'production' : 'staging'}"
    }
    stages {
        stage('Deploy') {
            steps {
                echo "Deploying to ${env.DEPLOY_TARGET}"
                // 部署逻辑
            }
        }
    }
}

更复杂的逻辑也可以用 Groovy 闭包实现：

environment {
    BRANCH_TYPE = "${
        if (env.BRANCH_NAME == 'main') {
            return 'production'
        } else if (env.BRANCH_NAME == 'develop') {
            return 'development'
        } else if (env.BRANCH_NAME.startsWith('feature/')) {
            return 'feature'
        } else {
            return 'unknown'
        }
    }"
}

自定义变量让逻辑更清晰、复用更方便。

5. 使用 Multibranch Pipeline 项目

Jenkins 的 Multibranch Pipeline 功能可自动识别 Git 仓库中的不同分支，并为每个分支创建对应的流水线任务。

5.1 配置 Multibranch Pipeline

配置步骤如下：

登录 Jenkins 控制台
点击 New Item
输入项目名称
选择 Multibranch Pipeline
在 Branch Sources 中配置 Git 仓库地址
设置分支发现策略（如扫描所有分支）
保存配置

Jenkins 会自动扫描仓库，为每个包含 Jenkinsfile 的分支创建流水线任务。

5.2 分支专属 Jenkinsfile

Multibranch Pipeline 的最大优势是可以为每个分支提供独立的 Jenkinsfile。例如：

feature 分支 Jenkinsfile：

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building feature branch'
            }
        }
        stage('Test') {
            steps {
                echo 'Running quick tests'
            }
        }
    }
}

main 分支 Jenkinsfile：

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building main branch'
            }
        }
        stage('Test') {
            steps {
                echo 'Running comprehensive test suite'
            }
        }
        stage('Deploy') {
            steps {
                echo 'Deploying to production'
            }
        }
    }
}

此外，也可以使用一个通用 Jenkinsfile 作为基础，再根据不同分支覆盖部分逻辑：

// Base Jenkinsfile
pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    if (env.BRANCH_NAME == 'main') {
                        echo 'Building for production'
                    } else {
                        echo 'Building for testing'
                    }
                }
            }
        }
    }
}

这样既能保持统一管理，又能实现高度定制。

6. 总结

本文介绍了在 Jenkinsfile 中处理不同分支的多种策略，包括：

✅ 使用 when 和 if-else 实现条件执行
✅ 利用 env.BRANCH_NAME 等环境变量识别分支
✅ 使用 Multibranch Pipeline 实现分支专属 Jenkinsfile
✅ 自定义环境变量提升可维护性

这些方法可以帮助你构建更灵活、更高效的 CI/CD 流水线，应对多分支场景下的复杂需求。

通过合理组合这些策略，你可以写出一个既能统一管理又能按需定制的 Jenkinsfile，从而提升项目的可维护性和可扩展性。

Persistence

REST

Security