一、插件简介
1、什么是 Gitee Jenkins Plugin ?
Gitee Jenkins Plugin 是码云基于 GitLab Plugin 开发的 Jenkins 插件。用于配置 Jenkins 触发器,接受码云平台发送的 WebHook 触发 Jenkins 进行自动化持续集成或持续部署,并可将构建状态反馈回码云平台。
2、目前支持特性:
推送代码到码云时,由配置的 WebHook 触发 Jenkins 任务构建。
提交 Pull Request 到码云仓库时,由配置的 WebHook 触发 Jenkins 任务构建,支持PR动作:新建,更新,接受,关闭,审查通过,测试通过。
支持 [ci-skip] 指令过滤。
过滤已经构建的 Commit 版本,若是分支 Push,则相同分支Push才过滤,若是 PR,则是同一个PR才过滤。
按分支名过滤触发器。
正则表达式过滤可触发的分支。
设置 WebHook 验证密码。
构建后操作可配置 PR 触发的构建结果评论到码云对应的PR中。
构建后操作可配置 PR 触发的构建成功后可自动合并对应PR。
对于 PR 相关的所有事件,若 PR 代码冲突不可自动合并,则不触发构建;且若配置了评论到PR的功能,则评论到 PR 提示冲突。
PR 评论可通过 WebHook 触发构建(可用于 PR 触发构建失败是便于从码云平台评论重新触发构建)
支持配置 PR 不要求必须测试时过滤触发构建。(可用于不需测试则不构建部署测试环境)
3、计划中特性
PR 审查并测试通过触发构建(可用户触发部署,且可配合自动合并 PR 的特性完善工作流。)
勾选触发方式自动添加WebHook至码云。
二、插件安装
1、在线安装
1.1、前往 Manage Jenkins -> Manage Plugins -> Available
点击“可选插件”,
1.2、右侧 Filter 输入: Gitee
1.3、下方可选列表中勾选 Gitee(如列表中不存在 Gitee,则点击 Check now 更新插件列表)
1.4、点击 Download now and install after restart
2、手动安装
2.1、从 release 列表中进入最新发行版,下载对应的 XXX.hpi 文件
2.2、前往 Manage Jenkins -> Manage Plugins -> Advanced
2.3、Upload Plugin File 中选择刚才下载的 XXX.hpi 点击 Upload
2.4、后续页面中勾选 Restart Jenkins when installation is complete and no jobs are running
三、插件配置
1、添加码云链接配置
1、前往 Jenkins -> Manage Jenkins -> Configure System -> Gitee Configuration -> Gitee connections
2、在 Connection name 中输入 Gitee 或者你想要的名字
3、Gitee host URL 中输入码云完整 URL地址: https://gitee.com (码云私有化客户输入部署的域名)
4、Credentials 中如还未配置码云 APIV5 私人令牌,点击 Add - > Jenkins
Domain 选择 Global credentials
Kind 选择 Gitee API Token
Scope 选择你需要的范围
Gitee API Token 输入你的码云私人令牌,获取地址:https://gitee.com/profile/personal_access_tokens
ID, Descripiton 中输入你想要的 ID 和描述即可。
前往:https://gitee.com/profile/personal_access_tokens, 获取 Gitee API Token
5、Credentials 选择配置好的 Gitee APIV5 Token
6、点击 Advanced ,可配置是否忽略 SSL 错误(适您的Jenkins环境是否支持),并可设置链接测超时时间(适您的网络环境而定)
7、点击 Test Connection 测试链接是否成功,如失败请检查以上 3,5,6 步骤。
配置成功后如图所示:
2、Jenkins 访问策略调整
参考资料
https://gitee.com/help/articles/4193#article-header4
更新时间:2023-12-28 09:15