用Jenkins Multi-branch Pipeline实现多分支构建和多环境部署

妖狐艹你老母 2022-12-26 02:18 660阅读 0赞

### 文章目录 ###

*  用Jenkins Multi-branch Pipeline实现多分支构建和多环境部署
 *   *  前言
     *  典型场景
     *  Core Concepts
     *  前置条件
     *  在GitHub上生成Personal Access Token
     *  在Jenkins中配置GitHub Personal Access Token
     *  新建Jenkins Multi-branch Pipeline
     *  在GitHub中配置Webhook
     *  测试
     *  维护Jenkinsfile
     *  参考文档

# 用Jenkins Multi-branch Pipeline实现多分支构建和多环境部署 #

## 前言 ##

Jenkins Pipeline适合对一个分支进行构建，并部署到一个环境中。

如果需要对多个分支进行构建，并部署到多个环境中，可以使用Jenkins Multi-branch Pipeline。

## 典型场景 ##

1.  开发人员从GitHub repository的`master`分支上创建一条新的分支`feature-xxx` （`xxx`一般为任务编号）。
2.  开发人员在本地开发测试，并push代码到`feature-xxx`分支。
3.  GitHub通过Webhook通知Jenkins运行构建，Jenkins对`feature-xxx`分支进行构建。
4.  `feature-xxx`分支的pipeline构建成功后，开发人员发起PR（Pull Request），试图合并到`master` 分支。
5.  GitHub通过Webhook通知Jenkins运行构建，Jenkins对`PR`进行构建。
6.  代码评审人员在Pull Request中可以看到`feature-xxx`和`PR`是否构建通过。
7.  代码经过评审后，被合并到`master`分支。
8.  GitHub repository的Webhook通知Jenkins，Jenkins对`master`分支进行构建。

## Core Concepts ##

*  Branch source - Which project (git repo) you want to build
 *  Credentials - Which credentials used to login git repo to clone code
    
     *  Credential scope:
        
         *  System - only for Jenkins server
         *  Global - for every where
         *  Folder - only for the multi branch pipeline (supported by Folder plugin)
 *  Branch - Which branches you want to build
    
     *  All branches - `.*` (all branches, Java regex syntax)
     *  Specific branches name - `^dev|master|feature.*$` (dev branch or master branch or feature branches)
 *  Region - Where (what code changes) to trigger build
 *  Trigger - When / What events to trigger build (GitHub / GitLab webhook)

Java regex references:

*  [Java Regex Tester][]
 *  [Java8 regex document][]

## 前置条件 ##

确保在Jenkins上已安装以下插件：

*  [GitHub Branch Source][]
 *  [Multibranch Scan Webhook Trigger][]
 *  [Multibranch Build Strategy Extention][]

## 在GitHub上生成Personal Access Token ##

在GitHub上，打开[https://github.com/settings/tokens][https_github.com_settings_tokens]，点击Generate new token，填写Note，在Select scopes中勾选repo。记住生成的token值，后面需要在Jenkins中配置credential。

## 在Jenkins中配置GitHub Personal Access Token ##

在Jenkins上，新建一个Global的Credential （凭据），选择类型为“Username with password"， Scope为“全局”，Username为`jenkins-user`，Password为上一步生成的GitHub Personal Access Token的值，ID值为一个有意义的字符串，Description中填入相应的描述。

## 新建Jenkins Multi-branch Pipeline ##

在Jenkins，New Item，输入流水线名称，选择“多分支流水线（Multi branch pipeline）”。

在Branch Sources中，点击Add source，选择GitHub。

在Credentials中选择上一步配置的GitHub personal access token。

选择Repository HTTPS URL，输入GitHub repository URL。

点击Validate按钮验证Jenkins是否可以正常访问指定的GitHub repository URL。

在Behaviours中：

*  Discover branches的Strategy选择“Exclude branches that are also filed as PRs"
 *  Discover pull requests from origin的Strategy选择为“Merging the pull request with the current target branch revision"
 *  Discover pull requests from forks的Strategy选择为”Merging the pull request with the current target branch revision"，Trust为“From users with Admin or Write permission"。

在Build strategies中，点击Add，选择Build included regions strategy中输入改动哪个地方的文件时才触发自动构建。确保填写正确的路径，如果路径不正确，则不会触发自动构建。

在Build Configuration中，选择Mode为by Jenkinsfile，Script Path为Jenkinsfile。如果Jenkinsfile不是放在根目录下或叫其他名字，则在Script Path中填入相应的值。

在Scan Repository Triggers中，勾选Scan by webhook，在Trigger token中输入一个唯一的字符串（不同Jenkins job该token值不同）。可以用`openssl rand -hex 8`来生成一个随机字符串来作为该token。

## 在GitHub中配置Webhook ##

在GitHub上，打开相应的repository的settings，选择Webhook。

点击Add webhooks。

在Payload URL中填入：`https://<jenkins_url>/multibranch-webhook-trigger/invoke?token=<token>`

Token为Jenkins job配置时“Scan Repository Trigger”中填写的token （注意，不要和GitHub Personal Access Token混淆了）。

示例： `https://jenkins.xdevops.cn/multibranch-webhook-trigger/invoke?token=a6cb104552964dc2`

Content type为"application/json"。

Secret保留为空，不填写。（这个Secret和Payload URL中的token没有关系）

SSL verification默认为Enable SSL verification。如果Jenkins是http协议，则勾选Disable。

勾选“Send me everything"。

默认勾选“Active”。

保存。

## 测试 ##

参照前面的“典型场景”进行测试。

## 维护Jenkinsfile ##

为一个GitHub repo的所有分支只维护一个Jenkinsfile。

在Jenkinsfile中对分支前缀进行判断，以区分不同的pipeline逻辑。

建议的分支命名规范：

*  主分支：`master`或`main`
 *  开发分支：`develop`或`dev`
 *  特性分支：`feature-*`
 *  Release分支：`release-*`
 *  Hofix分支：`hotfix-*`或`fix-*`

Pull request：

*  PR: `PR-*`

## 参考文档 ##

*  [Branches and Pull Requests][]
 *  [Multibranch Pipeline(With Github-webhook)][Multibranch Pipeline_With Github-webhook]
 *  [How to use Github Personal Access Token in Jenkins][]
 *  [How to trigger Multibranch Pipeline build with github webhook][]
 *  [https://devopscube.com/jenkins-multibranch-pipeline-tutorial/][https_devopscube.com_jenkins-multibranch-pipeline-tutorial]
 *  [Create Multibranch Pipeline with Git - Jenkins Pipeline Tutorial for Beginners 2/4][Create Multibranch Pipeline with Git - Jenkins Pipeline Tutorial for Beginners 2_4]

[Java Regex Tester]: http://java-regex-tester.appspot.com/
[Java8 regex document]: https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html
[GitHub Branch Source]: https://plugins.jenkins.io/github-branch-source/
[Multibranch Scan Webhook Trigger]: https://plugins.jenkins.io/multibranch-scan-webhook-trigger/
[Multibranch Build Strategy Extention]: https://plugins.jenkins.io/multibranch-build-strategy-extension
[https_github.com_settings_tokens]: https://github.com/settings/tokens
[Branches and Pull Requests]: https://www.jenkins.io/doc/book/pipeline/multibranch/
[Multibranch Pipeline_With Github-webhook]: https://blog.knoldus.com/multibranch-pipelinewith-github-webhook/
[How to use Github Personal Access Token in Jenkins]: https://stackoverflow.com/questions/61105368/how-to-use-github-personal-access-token-in-jenkins
[How to trigger Multibranch Pipeline build with github webhook]: https://stackoverflow.com/questions/43314483/how-to-trigger-multibranch-pipeline-build-with-github-webhook
[https_devopscube.com_jenkins-multibranch-pipeline-tutorial]: https://devopscube.com/jenkins-multibranch-pipeline-tutorial/
[Create Multibranch Pipeline with Git - Jenkins Pipeline Tutorial for Beginners 2_4]: https://www.youtube.com/watch?v=tuxO7ZXplRE&list=PLy7NrYWoggjw_LIiDK1LXdNN82uYuuuiC&index=2