一、 前言
多分支管道是一种基于 Git 分支自动创建 Jenkins Pipeline 的概念,这意味着,它可以在 SCM(Github)中创建时自动发现新的 Git 分支,并自动为该分支创建管道,当管道构建开始时,Jenkins 在该分支中使用 Jenkinsfile 进行构建阶段。 SCM 可以是 Github、Bitbucket 或 Gitlab 存储库,如果不希望所选分支出现在带有 Java 正则表达式的自动管道中,则可以选择排除。多分支管道支持基于 PR 的分支发现,这意味着,如果有人从分支提出 PR(拉动请求),则会在管道中自动发现分支。如果启用了此配置,则仅在提 PR 时才会触发构建。因此,如果正在寻找基于 PR 的 Jenkins 构建工作流程,这是一个不错的选择。 可以向 Jenkinsfile 添加条件逻辑,以根据分支需求构建作业。例如,如果希望功能分支仅运行单元测试和 Sonar 分析,则可以设置条件以使用 when 条件跳过部署阶段,如下所示:
stage ( 'Deploy for production') {
when {
branch 'production '
}
steps {
- - - -
}
}
因此,每当开发人员将 PR 从功能分支提交到其他分支时,管道将运行单元测试和 Sonar 分析阶段,从而跳过部署阶段。而且,多分支流水线不仅限于连续交付应用程序,当然也可以使用它来管理基础结构代码。
二、多分支管道如何工作?
这里将引导完成基本的构建和部署工作流程,以了解多分支管道的工作方式,假设希望 Jenkins 管道在以下条件下构建和部署应用程序:
每当开发人员从功能分支提 PR 来开发分支时,Jenkins 管道都应触发以运行单元测试和静态代码分析;
在功能分支中成功测试代码后,开发人员将 PR 合并到开发分支;
当代码准备发布时,开发人员将 PR 从 develop 分支提到 master,它应该触发一个构建管道,该管道将运行单元测试用例,代码分析并将其部署到 dev/QA 环境。 从以上条件可以看出,没有手动触发 Jenkins 作业的情况,并且每当有分支请求请求时,都需要自动触发管道并为该分支运行所需的步骤。此工作流程为工程师建立了一个很好的反馈循环,并避免了依赖 DevOps 团队在非产品环境中进行构建和部署,开发人员可以在 Github 上检查构建状态,然后决定下一步要做的事情。 通过 Jenkins 多分支管道可以轻松实现此工作流程,如下显示了以上示例构建过程的多分支管道工作流的外观:
这是多分支管道的工作方式:
当开发人员从功能分支创建 PR 来开发分支时,Github 将带有 PR 信息的 Webhook 发送给 Jenkins;
Jenkins 收到 PR,并找到相关的多分支管道并自动创建分支管道,然后它按照功能分支中 Jenkinsfile 中提到的步骤运行作业,签出期间,PR 中的源分支和目标分支将合并,PR 合并将在 Github 上被阻止,直到从 Jenkins 返回构建状态为止;
构建完成后,Jenkins 会将状态更新为 Github PR,现在将能够合并代码,另外如果想查看 Jenkins 构建日志,则可以在 PR 状态下找到 Jenkins 构建日志链接。
三、多分支 Pipleline Jenkinsfile
在开始实施之前,来看一下可在管道中使用的多分支管道 Jenkins 示例 Jenkinsfile,为了使多分支管道正常工作,需要在 SCM 存储库中包含 Jenkinsfile,如果正在学习/测试,则可以使用下面提供的多分支管道 Jenkinsfile,它具有一个检出阶段和其他阶段,它们会回显消息。另外,可以克隆并使用具有此 Jenkinsfile 的 Github 存储库。 需要注意的是:将代理标签“master”替换为我们的 Jenkins 代理名称,master 也可以工作,但不建议它在实际的项目环境中运行:
pipeline {
agent {
node {
label 'master '
}
}
options {
buildDiscarder logRotator (
daysToKeepStr: '16 ',
numToKeepStr: '10 '
)
}
stages {
stage ( 'Cleanup Workspace ') {
steps {
cleanWs ( )
sh "" "
echo " Cleaned Up Workspace For Project "
" ""
}
}
stage ( 'Code Checkout ') {
steps {
checkout ( [
$class : 'GitSCM ',
branches: [ [ name: '* / main'] ] ,
userRemoteConfigs: [ [ url: 'https : / / github. com/ spring- projects/ spring- petclinic. git'] ]
] )
}
}
stage ( ' Unit Testing ') {
steps {
sh "" "
echo " Running Unit Tests "
" ""
}
}
stage ( 'Code Analysis ') {
steps {
sh "" "
echo " Running Code Analysis "
" ""
}
}
stage ( 'Build Deploy Code ') {
when {
branch 'develop '
}
steps {
sh "" "
echo " Building Artifact "
" ""
sh "" "
echo " Deploying Code "
" ""
}
}
}
}
四、设置 Jenkins 多分支管道
在这里,将逐步在 Jenkins 上建立多分支管道,该设置将基于 Github 和最新的 Jenkins 2.x 版本,还可以将 Bitbucket 或 Gitlab 用作多分支管道的 SCM 源。 步骤 1:在 Jenkins 主页上创建一个“新项目”:
步骤 2:从选项中选择“多分支管道”,然后单击“确定”:
步骤 3:点击“添加来源”,然后选择 Github:
步骤 4:在认证字段下,选择 Jenkins 并使用 Github 用户名和密码创建一个认证:
步骤 5:选择创建的凭据,然后提供 Github 存储库以验证凭据,如果正在测试多分支管道,则可以克隆演示 Github 存储库并使用它,如下所示:
步骤 6:选择所需的选项以符合要求,可以选择发现存储库中的所有分支,也可以仅选择具有“拉取请求”的分支,管道还可以从分叉的仓库中发现具有 PR 的分支,选择这些选项取决于所需的工作流程:
可以从“添加”按钮中选择其他行为,例如如果选择不从存储库中发现所有分支,则可以选择正则表达式或通配符方法从存储库中发现分支,如下所示:
步骤 7:如果选择为 Jenkinsfile 使用其他名称,则可以通过在构建配置中指定名称来实现,在“脚本路径”选项中,可以提供所需的名称,确保仓库中的 Jenkinsfile 与在管道配置中提供的名称相同。另外,启用“放弃旧版本”以仅保留所需的生成日志,如下所示:
步骤 8:保存所有作业配置,Jenkins 扫描已配置的 Github 存储库,以查找所有提升了 PR 的分支。如下显示了扫描三个分支的作业,并且由于没有提出任何拉取请求,Jenkins 不会创建任何基于分支的管道,将展示如何在设置 Webhook 之后测试自动管道创建:
到目前为止,已经在 Jenkins 完成了配置,可以根据 PR 请求扫描分支。为了拥有完整的工作流程,需要在 Github 中配置一个 Webhook,以将所有事件(提交,PR 等)发送给 Jenkins,因为可以自动触发管道。
五、为多分支管道配置 Webhook
选择左侧的 webhook 选项,然后单击“添加 Webhook”按钮:
在有效负载 URL 下添加 Jenkins URL,后跟“ /github-webhook /”,选择内容类型为“application/json”,然后单击“添加 Webhook”,可以选择要在 Jenkins 中接收的 Webhook 类型。例如只想在 PR 期间触发管道,然后可以从“让我选择单个事件”选项中仅选择 PR 事件:
将在成功的 Webhook 配置上看到一个绿色的勾号 ,如下所示:
如果没有看到绿色的勾号或警告标志,请单击 Webhook 链接,然后单击最后一个 Webhook,应该能够使用状态代码查看为什么 Webhook 传递失败:
六、测试多分支管道
出于演示目的,选择了“仅将分支作为 PR 的分支”选项,使用此选项,仅发现具有 PR 请求的分支。要使用多分支管道,可以将此回购与示例 Jenkinsfile 一起使用。 这个仓库有三个分支,更新功能分支中自述文件中的某些内容,并提高 PR 以进行开发,它将向 Jenkins 发送一个 Webhook,并且 Jenkins 将发送回 Jenkins 的工作详细信息,并且 PR 将进入检查状态,如下所示:
如果单击“详细信息”,它将带到 Jenkins 构建日志,可以在 Jenkins 文件中编写自定义检查,以用于构建审核。现在,如果选择了 Jenkins,将在 Jenkins 中找到功能分支的管道,如下所示:
如果构建失败,则可以将更改提交到功能分支,并且只要 PR 打开,它将触发功能管线。在 Jenkinfile 中,如果分支未开发,添加一个条件以跳过部署阶段,可以在 Jenkins 构建日志中进行检查。另外,如果在蓝海仪表板中检查构建流程,则可以清楚地看到跳过的部署阶段,如下所示:
现在合并功能分支 PR 并将新的 PR 从 development 提升到 master 分支,Jenkins 将收到来自 Github 的 Webhook,以获取新的 PR,并如下所示创建开发管道:
对于开发分支,启用了部署阶段,如果检查 Blue Ocean 的构建流程,则可以看到所有阶段都已成功触发:
七、对多分支管道进行故障排除
分支发现问题:有时,即使在 SCM 中创建了新分支之后,它也可能不会反映在 Jenkins 管道中,可以尝试运行“立即扫描存储库”选项以再次扫描存储库,另外检查管道中的存储库扫描配置。 Webhooks 不会触发管道:当 Webhook 没有触发管道时,请检查 Github 中的 Webhook 交付状态代码和错误。另外,请检查 Jenkins URL 是否正确。 还要从 Manage Jenkins-> System Logs-> All Jenkins 日志中检查 Jenkins 日志,如果 Jenkins 能够接收 Webhook,则日志应显示未触发作业的原因。