使用 GitLab 事件触发器
目录
概述核心功能支持的事件类型基本事件信息基本变量(所有事件通用)1. Push 事件Push 事件变量2. Merge Request 事件Merge Request 事件变量3. 评论事件基本评论事件变量(所有评论事件通用)3.1 合并请求评论变量3.2 提交评论变量配置指南前置条件通过 GitLab UI 配置 WebhookPipeline 触发器配置示例概述
GitLab 事件触发器允许你通过 GitLab 的 Webhook 事件自动触发 Tekton 流水线。它支持多种事件类型,包括代码推送、合并请求、评论等,帮助你构建完整的 CI/CD 自动化工作流。
核心功能
- 多事件类型支持:支持 Push、Merge Request、评论等多种 GitLab 事件。
- 标准化触发器绑定:提供标准化的 ClusterTriggerBindings,确保跨平台一致性。
- 灵活的参数映射:自动从 GitLab 事件中提取关键信息,用于流水线参数。
- 安全的 Webhook 集成:支持 Webhook 安全验证。
支持的事件类型
基本事件信息
所有输出变量都可用于流水线参数映射。你可以使用 $(tt.params.<param name>) 访问参数值。
基本变量(所有事件通用)
1. Push 事件
当开发人员向 GitLab 仓库推送代码时触发。适用于:
- 持续集成构建
- 自动部署
- 代码质量检查
Push 事件变量
2. Merge Request 事件
当创建、更新或关闭合并请求时触发。适用于:
- 自动化代码审查
- 预发布环境部署
- 自动化测试
Merge Request 事件变量
TIP
请参阅你的 GitLab 实例的 webhook 文档,或参阅 GitLab 官方合并请求事件文档
3. 评论事件
支持以下评论类型:
- 合并请求评论
- 提交评论
适用于:
- ChatOps 评论自动化
基本评论事件变量(所有评论事件通用)
3.1 合并请求评论变量
3.2 提交评论变量
配置指南
前置条件
- 环境中已创建
EventListener,并且能够在目标命名空间中处理Trigger。更多信息请联系平台管理员。 - GitLab 可以访问上述
EventListener。 - 已创建所需的
Pipeline以及必要的运行配置。 - 你拥有修改 GitLab 项目 Webhook 设置的权限。
通过 GitLab UI 配置 Webhook
- 访问 GitLab 项目设置。
- 导航至 Settings > Webhooks。
- 根据
EventListener的部署模式添加 Webhook URL,例如使用https模式: - 根据需要选择事件类型:
- Push 事件
- 合并请求事件
- 评论
- (可选)配置 Secret Token。
- 点击“Add webhook”。
Pipeline 触发器配置示例
如果目标是通过触发器实现持续集成,并满足以下要求:
- 提交代码时自动触发自动化 CI 功能。
- 创建合并请求时自动触发 CI Pipeline。
为简化本文档,我们假设 Pipeline 已准备就绪,并提供了以下参数:
TIP
请替换为实际的 Pipeline 信息。
接下来,我们只需要配置以下两个触发器:
创建 Push 触发器
将以下 YAML 保存为 gitlab-push-trigger.yaml:
在环境中创建资源:
创建合并请求触发器
将以下 YAML 保存为 gitlab-merge-request-trigger.yaml:
TIP
请根据需要调整 Interceptor 配置。
在环境中创建资源:
验证触发器
通过提交代码并创建合并请求进行验证。
CLI:
可以使用 kubectl -n <namespace> get pipelinerun 获取 Pipeline 执行状态。
控制台:
访问 Pipelines > PipelineRuns 查看已触发的 Pipeline。