Jenkins系列（二）——配置Gitee仓库实现自动化构建

系列文章目录

Jenkins系列（一）——环境搭建部署
Jenkins系列（二）——配置Gitee仓库实现自动化构建
Jenkins系列（三）——Docker镜像推送与部署

---

---

一、插件安装

1.在线安装

• 前往 Manage Jenkins -> Manage Plugins -> Available
• 右侧 Filter 输入： Gitee
• 下方可选列表中勾选 Gitee（如列表中不存在 Gitee，则点击 Check now 更新插件列表）
• 点击 Download now and install after restart
  

2.手动安装

• 从 release 列表中进入最新发行版，下载对应的 XXX.hpi 文件
• 前往 Manage Jenkins -> Manage Plugins -> Advanced
• Upload Plugin File 中选择刚才下载的 XXX.hpi 点击 Upload
• 后续页面中勾选 Restart Jenkins when installation is complete and no jobs are running
  

二、插件配置

1.添加Gitee链接配置

1. 前往 Jenkins -> Manage Jenkins -> Configure System -> Gitee Configuration -> Gitee connections
2. 在 Connection name 中输入 Gitee 或者你想要的名字
3. Gitee host URL 中输入Gitee完整 URL地址： https://gitee.com （Gitee私有化客户输入部署的域名）
4. Credentials 中如还未配置Gitee APIV5 私人令牌，点击 Add - > Jenkins
   1. Domain 选择 Global credentials
   2. Kind 选择 Gitee API Token
   3. Scope 选择你需要的范围
   4. Gitee API Token 输入你的Gitee私人令牌，获取地址：https://gitee.com/profile/personal_access_tokens
   5. ID, Descripiton 中输入你想要的 ID 和描述即可。
5. Credentials 选择配置好的 Gitee APIV5 Token
6. 点击 Advanced ，可配置是否忽略 SSL 错误（视您的Jenkins环境是否支持），并可设置链接测超时时间（视您的网络环境而定）
7. 点击 Test Connection 测试链接是否成功，如失败请检查以上 3，5，6 步骤。
   配置成功以后：

三.任务建立与配置

1.新建任务

前往 Jenkins -> 新建任务 , 名称 输入 ‘ServiceApiSample’，选择 构建一个自由风格的软件项目 保存即可创建构建项目。

2.任务全局配置

任务全局配置中需要选择前一步中的Gitee链接。前往某个任务（如’ServiceApiSample’）的 配置 -> General，Gitee connection 中选择前面所配置的Gitee链接，如图：

3.源码管理配置

前往某个任务（如’Gitee Test’）的 Configure -> Source Code Management 选项卡

• 点击 Git

• 输入你的仓库地址，例如 git@your.gitee.server:gitee_group/gitee_project.git

• 点击 Advanced 按钮, Name 字段中输入 origin， Refspec 字段输入 +refs/heads/:refs/remotes/origin/ +refs/pull//MERGE:refs/pull//MERGE
  ，注意新版jenkins不再接受多条同时包含 * 通配符的refs描述，如只对push触发可写前半部分，如只对PR触发可只写后半段。具体可见下图：
  

• 凭据Credentials 中请输入 git 仓库 https 地址对应的 用户名密码凭据，或者 ssh 对应的 ssh key 凭据，注意 Gitee API Token 凭据不可用于源码管理的凭据，只用于 gitee 插件的 API 调用凭据。

• 1. Branch Specifier 选项:
  2. 对于单仓库工作流输入: origin/${giteeSourceBranch}
  3. 对于 PR 工作流输入: pull/${giteePullRequestIid}/MERGE

• Additional Behaviours 选项：

• 对于单仓库工作流，如果你希望推送的分支构建前合并默认分支（发布的分支），可以做以下操作：

  1. 点击 Add 下拉框
  2. 选择 Merge before build
  3. 设置 Name of repository 为 origin
  4. 设置 Branch to merge to 为 ${ReleaseBranch} 即您要合并的默认分支（发布分支）

• 对于 PR 工作流，Gitee服务端已经将 PR 的原分支和目标分支作了预合并，您可以直接构建，如果目标分支不是默认分支（发布分支），您也可以进行上诉构建前合并。
  配置如图所示：
  

四.触发器配置

1.源码触发器

前往任务配置的触发器构建： Configure -> Build Triggers 选项卡

1、 Enabled Gitee triggers 勾选您所需要的构建触发规则，如 Push Event, Opened Merge Request Events，勾选的事件会接受WebHook，触发构建。目前支持触发事件有：

• Push Events ：推送代码事件
• Commit Comment Events ：评论提交记录事件
• Opened Merge Request Events ：提交 PR 事件
• Updated Merge Request Events ：更新 PR 事件
• Accepted Merge Request Events ：接受/合并 PR 事件
• Closed Merge Request Events ：关闭 PR 事件
• Approved Pull Requests ： 审查通过 PR 事件
• Tested Pull Requests ：测试通过 PR 事件

2、Build Instruction Filter :

• None : 无过滤
• [ci-skip] skip build ：commit message 或者 PR 说明包含 [ci-skip] 时，跳过构建触发。
• [ci-build] trigger build ：commit message 或者 PR 说明包含 [ci-build] 时，触发构建。

3、Ignore last commit has build 该选项可以跳过已经构建过的 Commit 版本。
4、Cancel incomplete build on same Pull Requests 该选项在 PR 触发构建时，会判断是否存在相同 PR 且未完成的构建，有则取消未完成构建，再进行当前构建。
5、Ignore Pull Request conflicts 该选项在 PR 触发构建时，会根据 PR 冲突情况选择是否进行构建。
6、Allowed branches 可以配置允许构建的分支，目前支持分支名和正则表达式的方式进行过滤。
7、Secret Token for Gitee WebHook 该选项可以配置 WebHook 的密码，该密码需要与Gitee WebHook配置的密码一致方可触发构建。
8、注意：若 PR 状态为不可自动合并，则不触发构建。

2.WebHook配置

进入源码管理配置中设置的Gitee项目中，进入 管理 -> WebHooks

1. 添加 WebHook， URL 填写 触发器配置：Build when a change is pushed to Gitee. Gitee webhook URL 中所示 URL，如：: http://127.0.0.1:8080/jenkins/project/fu
2. 密码填写：触发器配置第 5 点中配置的 WebHook密码，不设密码可以不填
3. 勾选 PUSH， Pull Request

3.测试推送触发构建

1. Gitee的 WebHook 管理中选择勾选了PUSH的 WebHook 点击测试，观察 Jenkins 任务的构建状态
2. Gitee项目页面编辑一个文件提交，观察 Jenkins 任务的构建状态
   
   因为是测试链接是否正常所以Jenkins那边只会构建不会成功：
   

总结

参考地址：Gitee配置 Jenkins 插件文档
Gitee官方文档Jenkins配置写的很详尽，一些基础配置按照文档配置便没什么问题！