Gitee Jenkins Plugin码云持续集成插件

最新推荐文章于 2024-03-28 18:54:52 发布
最新推荐文章于 2024-03-28 18:54:52 发布
阅读量8.4k 收藏 10
点赞数 1
分类专栏： DevOps

插件地址：https://gitee.com/oschina/Gitee-Jenkins-Plugin

目录

简介

Gitee Jenkins Plugin 是码云基于 GitLab Plugin 开发的 Jenkins 插件。用于配置 Jenkins 触发器，接受码云平台发送的 WebHook 触发 Jenkins 进行自动化持续集成或持续部署，并可将构建状态反馈回码云平台。

目前支持特性：

  • 推送代码到码云时，由配置的 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 不要求必须测试时过滤触发构建。（可用于不需测试则不构建部署测试环境）

计划中特性

  1. PR 审查并测试通过触发构建（可用户触发部署，且可配合自动合并 PR 的特性完善工作流。）
  2. 勾选触发方式自动添加WebHook至码云。

插件安装

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

输入图片说明

  1. 手动安装
    • 从 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. 前往 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
    1. Domain 选择 Global credentials
    2. Kind 选择 Gitee API Token
    3. Scope 选择你需要的范围
    4. Gitee API Token 输入你的码云私人令牌，获取地址：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 步骤。

配置成功后如图所示： 码云链接配置

新建构建任务

前往 Jenkins -> New Item , name 输入 'Gitee Test'，选择 Freestyle project 保存即可创建构建项目。

任务全局配置

任务全局配置中需要选择前一步中的码云链接。前往某个任务（如'Gitee Test'）的 Configure -> General，Gitee connection 中选择前面所配置的码云联机，如图：

任务全局配置

源码管理配置

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

  1. 点击 Git
  2. 输入你的仓库地址，例如 git@your.gitee.server:gitee_group/gitee_project.git
    1. 点击 Advanced 按钮, Name 字段中输入 origin， Refspec 字段输入 +refs/heads/*:refs/remotes/origin/* +refs/pull/*/MERGE:refs/pull/*/MERGE
  3. Branch Specifier 选项:
    1. 对于单仓库工作流输入: origin/${giteeSourceBranch}
    2. 对于 PR 工作流输入: pull/${giteePullRequestIid}/MERGE
  4. Additional Behaviours 选项：
    1. 对于单仓库工作流，如果你希望推送的分支构建前合并默认分支（发布的分支），可以做以下操作：
      1. 点击 Add 下拉框
      2. 选择 Merge before build
      3. 设置 Name of repository 为 origin
      4. 设置 Branch to merge to 为 ${ReleaseBranch} 即您要合并的默认分支（发布分支）
    2. 对于 PR 工作流，码云服务端已经将 PR 的原分支和目标分支作了预合并，您可以直接构建，如果目标分支不是默认分支（发布分支），您也可以进行上诉构建前合并。

配置如图所示：

源码管理配置

触发器配置

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

  1. Enabled Gitee triggers 勾选您所需要的构建触发规则，如 Push Event, Opened Merge Request Events，勾选的事件会接受WebHook，触发构建。目前支持触发事件有：
    • Push 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. Enable [ci-skip] 该选项可以开启支持 [ci-skip] 指令，只要commit message 中包含 [ci-skip]，当前commit 即可跳过构建触发。
  3. Ignore last commit has build 该选项可以跳过已经构建过的 Commit 版本。
  4. Allowed branches 可以配置允许构建的分支，目前支持分支名和正则表达式的方式进行过滤。
  5. Secret Token for Gitee WebHook 该选项可以配置 WebHook 的密码，该密码需要与码云 WebHook配置的密码一致方可触发构建。
  6. 注意：若 PR 状态为不可自动合并，则不触发构建。

触发器配置

构建后步骤配置

前往任务配置的构建后配置： Configure -> Post-build Actions 选项卡

构建结果回评至码云

  1. 点击 Add post-build action 下拉框选择：Add note with build status on Gitee pull requests
  2. Advanced 中可以配置：
    • Add message only for failed builds ：仅为构建失败回评到码云
    • 自定义各状态的回评内容（内容可以引用 Jenkins 的环境变量，或者自定义的环境变量）
  3. 若开启该功能，还可将不可自动合并的状态回评至码云

构建成功自动合并PR

点击 Add post-build action 下拉框选择：Accept Gitee pull request on success

构建后步骤配置

新建码云项目WebHook

进入源码管理配置中设置的码云项目中，进入 管理 -> 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

测试推送触发构建

  1. 码云的 WebHook 管理中选择勾选了PUSH的 WebHook 点击测试，观察 Jenkins 任务的构建状态
  2. 码云项目页面编辑一个文件提交，观察 Jenkins 任务的构建状态

测试PR触发构建

  1. 码云的 WebHook 管理中选择勾选了 Pull Request 的 WebHook 点击测试，观察 Jenkins 任务的构建状态
  2. 在码云项目中新建一个Pull Request，观察 Jenkins 任务的构建状态

环境变量

目前支持环境变量见以下函数，其中不同的 WebHook 触发可能导致有些变量为空，具体请安装插件 EnvInject Plugin，于构建中查看 Environment Variables

    public Map<String, String> getBuildVariables() {
        MapWrapper<String, String> variables = new MapWrapper<>(new HashMap<String, String>());
        variables.put("giteeBranch", branch);
        variables.put("giteeSourceBranch", sourceBranch);
        variables.put("giteeActionType", actionType.name());
        variables.put("giteeUserName", userName);
        variables.put("giteeUserEmail", userEmail);
        variables.put("giteeSourceRepoHomepage", sourceRepoHomepage);
        variables.put("giteeSourceRepoName", sourceRepoName);
        variables.put("giteeSourceNamespace", sourceNamespace);
        variables.put("giteeSourceRepoURL", sourceRepoUrl);
        variables.put("giteeSourceRepoSshUrl", sourceRepoSshUrl);
        variables.put("giteeSourceRepoHttpUrl", sourceRepoHttpUrl);
        variables.put("giteePullRequestTitle", pullRequestTitle);
        variables.put("giteePullRequestDescription", pullRequestDescription);
        variables.put("giteePullRequestId", pullRequestId == null ? "" : pullRequestId.toString());
        variables.put("giteePullRequestIid", pullRequestIid == null ? "" : pullRequestIid.toString());
        variables.put("giteePullRequestTargetProjectId", pullRequestTargetProjectId == null ? "" : pullRequestTargetProjectId.toString());
        variables.put("giteePullRequestLastCommit", lastCommit);
        variables.put("giteePushCreated", created ? "true" : "false");
        variables.put("giteePushDeleted", deleted ? "true" : "false");
        variables.putIfNotNull("giteePullRequestState", pullRequestState);
        variables.putIfNotNull("giteeMergedByUser", mergedByUser);
        variables.putIfNotNull("giteePullRequestAssignee", pullRequestAssignee);
        variables.put("giteeTargetBranch", targetBranch);
        variables.put("giteeTargetRepoName", targetRepoName);
        variables.put("giteeTargetNamespace", targetNamespace);
        variables.put("giteeTargetRepoSshUrl", targetRepoSshUrl);
        variables.put("giteeTargetRepoHttpUrl", targetRepoHttpUrl);
        variables.put("giteeBefore", before);
        variables.put("giteeAfter", after);
        variables.put("ref", ref);
        variables.put("beforeSha", beforeSha);
        variables.put("isTag", isTag);
        variables.put("sha", sha);
        variables.put("status", status);
        variables.put("stages", stages);
        variables.put("createdAt", createdAt);
        variables.put("finishedAt", finishedAt);
        variables.put("duration", buildDuration);
        variables.putIfNotNull("giteeTriggerPhrase", triggerPhrase);
        return variables;
    }

用户支持

如在使用过程中有任何疑问，欢迎在 Gitee Jenkins Issue 中反馈。

反馈前可按以下步骤获取更多日志以便排查问题：

  1. 前往 Jenkins -> Manage Jenkins -> System Log
  2. 点击 Add new log recorder。
  3. 输入 'Gitee Jenkins Plugin'。
  4. 在下一页面中 Logger 点击 Add ，输入框中填写 'com.gitee.jenkins'，并在 Log level 总选择全部，保存。
  5. 完成以上步骤后便可在 'Gitee Jenkins Plugin' 这个日志中查看。

参与贡献

欢迎提交 CI 场景特性建议或者直接提交 PR 贡献代码。

打包或运行测试

打包 hpi 文件在仓库目录中执行： mvn package

直接运行测试执行：mvn hpi:run

boonya
关注
  • 1
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
Gitee Jenkins Plugin 是码云基于 GitLab Plugin 开发的 Jenkins 插件
05-21
Gitee Jenkins Plugin 是码云基于 GitLab Plugin 开发的 Jenkins 插件。用于配置 Jenkins 触发器，接受码云平台发送的 WebHook 触发 Jenkins 进行自动化持续集成或持续部署，并可将构建状态反馈回码云平台。
【技术干货】基于码云 Gitee 的云原生持续集成工作流
ZicoChan的博客
08-11 882
本文介绍一种基于Gitee的持续集成工作流及其实现，读者可以通过阅读本文，从 0 实现一个生产级以 Gitee 仓库为核心的云原生持续集成工作流。 在日常开发过程中，通常会有多个业务或功能模块同时开发，这些在 git 工作流中都以分支的形式共存在一个代码仓库中，当开发完成后向发布分支提交 PR 以合并到发布分支完成发布，这时我们的测试工作就落到了对这些 PR 的部署和测试上，对于多个 PR 的部署我们有什么方便、快捷、自动化的部署方案呢？ 于是本文就以开发环境中多 PR 同时部署和测试为例，实现一个包含
使用码云做持续集成
sinat_38566034的博客
10-24 3477
1、注册账号2、新建一个项目3、确定开发流程项目地址 https 码云的https链接地址来和码云上的项目交互的时候，根据项目的特性，有时候可能需要输入用户名和密码。公有项目因为公有项目允许任何人clone、pull等只读操作，因此不需要密码。克隆 git clone https://gitee.com/hjsiamcer/lnmp.git pullgit pull origin master参
(4)jenkins配置gitee令牌详细操作
qq_36332465的博客
02-27 358
类型修改为Gitee API，令牌改为刚刚获取的。登录自己的账号，通过这个地址，建立密钥。
Jenkins + Gitee + Maven 自动化部署 Spring Boot
拾一二的博客
01-29 5944
jenkins的资料太多，本文经过亲手实践吐血整理而出，如何在Window下通过使用Jenkins实现对maven项目的自动构建、推送、部署、测试等
Jenkins插件配置----Gitee插件配置
redrose2100的博客
11-30 3990
Jenkins安装----基于CentOS7搭建Jenkins Jenkins凭据管理----配置用户名密码 Jenkins凭据管理----配置ssh私钥 Jenkins凭据管理----配置Gitee私钥 Jenkins节点管理----添加节点 Jenkins插件配置-Gitee插件配置 Jenkins任务管理----创建一个自有风格的软件项目的构建任务（从gitee代码仓拉取代码） Jenkins任务管理----Jenkins+Pytest+Allure搭建自动化测试任务（基于自由风格软件项目构建任务）
实战：Docker+Jenkins+Gitee构建CICD流水线
qq_45635347的博客
08-27 684
持续集成和持续交付一直是当下流行的开发运维方式，CICD省去了大量的运维时间，也能够提高开发者代码集成规范。开发者在开发完需求功能后可以直接提交到gitee，然后jenkins直接进行代码编译和一体化流水线部署。通过流水线部署可以极大的提高devops效率，也是企业信息自动化的一种体现。
jenkins+jmeter持续集成.pdf
05-21
本文档介绍了如何通过Jenkins和jmeter实现接口自动化测试，并通过邮件发送测试报告，很经典的一个文档。
Jenkins搭建C++持续集成环境
01-27
本文主要介绍如何通过Jenkins搭建C++的持续集成环境。最后达到的效果是每天00:00- 08:00之间构建、测试和打包一次工程。开发环境为VS2015，测试工具为CppUnit，打包工具为InnoSetup。本例的Jenkins版本为Jenkins2.60...
初试Jenkins2.0Pipeline持续集成
02-25
初试Jenkins2.0Pipeline持续集成目录：Jenkins2.0介绍环境、软件准备安装、启动并配置jenkins服务新建PipelineJobDemoFAQ1、Jenkins2.0介绍先介绍下什么是Jenkins2.0，Jenkins2.0的精髓是PipelineasCode，是帮助...
基于Gitee实现Jenkins自动化部署SpringBoot项目
Hi，我是sharkchili，CSDN Java领域博客专家，开源项目JavaGuide维护人员，我想写一些有意思的东西，希望对你有帮助。
03-06 1844
近期项目组需要对老项目做一些持续集成和持续部署的要求，所以再次部署了一边Jenkins，将整个配置过程记录到博客中。在部署的过程中笔者尝试通过阿里云的方式部署了一遍，而本文为了更直观的介绍整个过程会给予虚拟机再次进行部署。注:本篇教程部署过程是基于外网部署的，关于内网的部署过程后续笔者会将文章整理出来。
GitHub开源项目权限管理-使用账号和个人令牌访问
最新发布
AndroidDeveloper的专栏
03-28 361
7.打开git 版本管理工具，使用https的方式访问，输入账号，密码栏输入刚才的证书。选择保存密码，后面就可以直接访问了。3.找到Personal access tokens 的 Tokens(classic)2.找到左下角的Developer settings。6.点击生成证书，复制证书并且保存起来，1.打开后台账号设置。
Jenkins + Gitee 实现代码自动化构建 （超级详细）
热门推荐
达拉崩巴斑得贝迪卜多比鲁翁_
10-28 1万+
部署vue项目和H5唯一不同的点就是，执行shell的命令不一样，下面是我shell执行的命令， 可以参照一下， 路径一定根据自己的情况变化。jenkins就会开始构建，构建的时候执行shell里脚本， 进入你的项目文件夹，git pull。3： 安装Gitee插件(系统管理->插件管理->可选插件->筛选Gitee->选中直接安装，安装成功之后重启jenkins服务)这个时候， 只要你执行 git push 命令，jenkins就会开始构建部署。如果爆红提示没有权限，检查上一步，你的帐密输错了没。
github创建个人令牌-简单易懂
不忘的博客
10-11 4012
github 个人令牌的使用
docker-Jenkins之Gitee Push后自动构建和运行
weixin_44347271的博客
11-17 1122
1、Gitee Push自动构建配置 这一步官方文档讲得很清楚了，大家可自行参考配置。 Gitee Jenkins插件官方文档 这里提一嘴Gitee仓库中的webhook配置 这里的URL来自于Jenkins 项目使用Gitee插件的配置中。 WebHook密码也来自于配置 gitee和jenkins的webhook密码保持一致。 配置完成后点击测试，gitee会向jenkins发送消息，正常情况下jenkins中的项目就开始自动构建了。 2、构建后自动运行 我的项目是一个Springboot项目，
jenkins整合gitee自动部署SpringBoot项目
huiguo_的博客
05-08 1326
文章目录前提条件一、服务器安装jenkins方法一：简单快捷第一步：将jenkens.war导入到系统第二步：放在tomcat的webapp下面第三步：访问http://ip:8080/jenkins方法二：命令行部署jenkins第一步：启用Jenkins库第二步：安装Jenkins第三步：启动Jenkins登录Jenkins二、自动部署所需要的插件一、Spring Boot部署Maven所需要的插件1、系统管理 -> 插件管理 -> 可选插件 -> 根据插件名字搜索安装即可。如上图。2
Linux安装Jenkins搭配Gitee自动化部署Springboot项目
DD-Blog
04-23 1379
Jenkins是一款流行的开源持续集成（CI）和持续交付（CD）工具。 本文手把手教你Linux安装Jenkins搭配Gitee自动化部署Springboot项目
Git使用个人访问令牌提交代码到仓库
qq_43401552的博客
01-31 7990
Github新版本，无法使用账号和密码对GitHub仓库，操作Git使用个人访问令牌提交代码到仓库
gitee jenkins
09-09
Gitee Jenkins是码云基于GitLab Plugin开发的Jenkins插件。它用于配置Jenkins触发器，接受码云平台发送的WebHook来触发Jenkins进行自动化持续集成或持续部署，并且可以将构建状态反馈回码云平台。 在使用Gitee ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值