CI/CD / 系统课时

为多分支自动发现流水线

为多分支自动发现流水线

当同一仓库同时维护功能分支、发布分支和主分支时,为每个分支手工创建 Jenkins 任务很快会失控。Multibranch Pipeline 可以扫描仓库、发现符合条件的分支,并分别读取各分支自己的 Jenkinsfile 创建流水线。

学习目标

  • 理解 Multibranch Pipeline 的分支发现与任务生成机制
  • 配置仓库来源并让 Jenkins 从各分支加载 Jenkinsfile
  • 验证新增、修改和删除分支后的扫描结果

多分支流水线解决什么问题

普通 Pipeline 通常对应一个固定任务。团队同时开发多个分支时,如果复制出 app-main、app-feature-a、app-release 等任务,配置会逐渐漂移,而且新增分支还需要人工创建任务。

Multibranch Pipeline 把仓库作为管理对象。Jenkins 扫描仓库后识别候选分支,并检查各分支是否包含可用的 Jenkinsfile;符合条件的分支会形成独立的分支任务,构建时读取该分支自己的流水线定义。

Multibranch Pipeline 自动发现分支并加载 Jenkinsfile

这种模型的关键不是“一个流水线依次构建所有分支”,而是一个 Multibranch Pipeline 管理多个分支流水线。不同分支可以拥有不同版本的 Jenkinsfile,因此流水线变更也能够跟随代码分支一起评审和演进。

准备各分支的 Jenkinsfile

下面给出一个最小 Declarative Pipeline。将它保存为仓库根目录的 Jenkinsfile,用于验证 Jenkins 能否从分支加载流水线定义。

groovy
pipeline {
    agent any

    stages {
        stage('Branch Info') {
            steps {
                echo "Building branch: ${env.BRANCH_NAME}"
            }
        }
    }
}

预期输出:

text
Building branch: <BRANCH>

<BRANCH> 是 Jenkins 当前分支任务对应的实际分支名。在 Multibranch Pipeline 中,BRANCH_NAME 由 Jenkins 提供,不需要在 Jenkinsfile 中手工定义。

如果某个分支没有 Jenkinsfile,而项目配置要求从根目录读取 Jenkinsfile,该分支通常不会形成可构建的分支流水线。若项目把流水线文件放在其他位置,则应在 Multibranch Pipeline 的构建配置中使用实际脚本路径。

创建 Multibranch Pipeline

在 Jenkins 中新建 Multibranch Pipeline,然后配置 Branch Sources。根据代码托管平台选择 Git、GitHub、GitLab 或其他已安装插件提供的来源,并填写仓库地址以及访问私有仓库所需的凭据。

仓库来源确定后,再配置分支发现策略和过滤规则。生产仓库通常不需要扫描所有临时分支,可以根据插件提供的发现行为或名称过滤能力缩小范围。这里应优先使用 Jenkins 当前安装插件实际提供的选项,而不是假设不同代码托管插件拥有完全相同的配置项。

保存项目后,Jenkins 会执行 Branch Indexing。扫描结果是验证配置的重要入口:它会显示发现了哪些分支,以及 Jenkins 是否在候选分支中识别到流水线定义。

验证自动发现

可以从本地创建一个测试分支,确保其中已有 Jenkinsfile,然后推送到远程仓库:

bash
git switch -c feature/webhook-test
git push -u origin feature/webhook-test

预期输出:

text
branch 'feature/webhook-test' set up to track 'origin/feature/webhook-test'.

不同 Git 版本和远程服务可能输出额外信息。随后在 Jenkins 执行一次分支扫描;如果项目还配置了仓库事件触发,远程分支变化也可以促使 Jenkins 重新索引。扫描完成后,应能在 Multibranch Pipeline 下看到 feature/webhook-test 对应的分支任务,并从该分支读取 Jenkinsfile。

验证时不要只看“任务出现了”。还应打开该分支的一次构建日志,确认 BRANCH_NAME 与远程分支一致,这才能证明 Jenkins 实际执行的是正确分支上下文。

分支变化如何反映到 Jenkins

Multibranch Pipeline 的核心动作是 Branch Indexing。新增远程分支后,Jenkins 需要再次发现它;已有分支的 Jenkinsfile 被修改后,该分支后续构建会使用对应版本;远程分支被删除后,Jenkins 会在后续索引中识别其消失,相关分支任务如何保留或清理由项目和 Jenkins 的孤儿项目策略决定。

当仓库长期存在大量短生命周期分支时,还应配置合理的分支过滤与孤儿项目保留策略,否则 Jenkins 中会积累大量已经失去实际价值的分支任务。Multibranch Pipeline 的价值正是在仓库结构变化时自动维护流水线入口,而不是把手工任务复制工作换一种形式继续保留。

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

目录与阅读设置

阅读设置

17

记录一个想法

为多分支自动发现流水线

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

登录哪都通