更新时间:2025-02-28 gmt 08:00

配置webhook-九游平台

约束限制

  • 当用户角色为“项目经理”或者“项目管理员”,可以设置项目级webhook。
  • 每个仓库最多只能设置20个webhook。

配置webhook设置

开发人员可在webhook界面配置第三方系统的url,并根据项目需求订阅代码托管仓库的分支推送(push)、标签推送(tag push)等事件。当订阅事件发生时,可通过webhook向第三方系统的url发送 post请求,用以触发自己系统(第三方系统)的相关操作,例如:触发自己系统(第三方系统)界面的通知弹窗;或触发自己系统(第三方系统)的构建、更新镜像、部署等操作。

webhook设置位于仓库详情中的 设置 > 服务集成 > webhook设置

表1 新建webhook字段说明

字段

说明

名称

必填项。可自定义名称,至多200个字符。

描述

非必填项。用于描述该webhook,至多200个字符。

url

必填项。url及其响应中均不能有敏感数据,如果一定要包含,需用户自行加解密以保证安全性。webhook url需第三方ci/cd系统提供。

token类型

非必填项。用于第三方服务webhook接口鉴权,鉴权信息放在http请求header,作为key,和下一个参数“token”结合使用,包含以下三个选项:

  • x-repo-token
  • x-gitlab-token
  • x-auth-token

用户在配置webhook的时候,可以选择设置用户的token,该token会与用户的webhook url关联,系统会将该token放在请求头的“x-repo-token”字段发送给用户。

token

非必填项。用于第三方ci/cd系统鉴权,鉴权信息放在http请求header,作为value,和上一个参数“token类型”结合使用。

事件类型

必填项。系统可订阅以下事件:

  • 推送事件。勾选后,则需要继续填写“分支过滤正则规则”,长度不能超过500个字符,“.*”表示匹配全部分支,如果分支名称匹配设置的正则,在repo仓库进行代码更新,例如更新子模块中的代码、在线或本地git客户端中推送代码均会触发该事件。
  • 合并请求事件。勾选后,更新合并请求的代码、关闭合并请求、重开合并请求、更新合并请求标题或描述、更新合并人、更新工作项、删除源分支或者更新squash合并,都会触发该事件。
  • tag推送事件。勾选后,新建或删除tag均会触发该事件。
  • 评论事件。勾选后,在代码文件中添加检视意见、在提交详情文件变更下添加检视意见、在合并请求文件变更中添加检视意见、在仓库提交详情和在合并请求详情中添加评论会触发该事件。

相关文档

网站地图