#Использование триггеров событий GitLab

#Обзор

Триггеры событий GitLab позволяют автоматически запускать конвейеры Tekton через события вебхуков GitLab. Поддерживает несколько типов событий, включая коммиты кода, запросы на слияние, комментарии и т. д., что позволяет вам создать полный рабочий процесс автоматизации CI/CD.

#Основные функции

• Поддержка нескольких типов событий: Поддерживает различные события GitLab, такие как коммиты, запросы на слияние, комментарии и т. д.
• Стандартизированное связывание триггеров: Обеспечивает стандартизированные ClusterTriggerBindings для обеспечения согласованности между платформами.
• Гибкое сопоставление параметров: Автоматически извлекает ключевую информацию из событий GitLab для параметров конвейеров.
• Безопасная интеграция вебхуков: Поддерживает проверку безопасности вебхуков.

#Поддерживаемые типы событий

#Основная информация о событиях

Все выходные переменные могут быть использованы для сопоставления параметров конвейеров. Вы можете получить доступ к значениям параметров с помощью $(tt.params.<имя параметра>).

#Основные переменные (общие для всех событий)

#1. Событие коммита

Происходит, когда разработчик загружает код в репозиторий GitLab. Подходит для:

• Сборок непрерывной интеграции
• Автоматизированного развертывания
• Проверок качества кода

#Переменные события коммита

#2. Событие запроса на слияние

Происходит, когда запрос на слияние создается, обновляется или закрывается. Подходит для:

• Автоматизированных проверок кода
• Развертываний в предрелизной среде
• Автоматизированного тестирования

#Переменные события запроса на слияние

#3. События комментариев

Поддерживает следующие типы комментариев:

• Комментарии к запросам на слияние
• Комментарии к коммитам

Подходит для:

• Автоматизации комментариев ChatOps

#Основные переменные событий комментариев (общие для всех событий комментариев)

#3.1 Переменные комментариев к запросу на слияние

#3.2 Переменные комментариев к коммитам

#Руководство по настройке

#Предварительные условия

1. В вашей среде создан EventListener, способный обрабатывать Trigger в целевом пространстве имен. Пожалуйста, свяжитесь с вашим администратором платформы для получения дополнительной информации.
2. GitLab может получить доступ к упомянутому выше EventListener.
3. Требуемый Pipeline, а также необходимые настройки для его выполнения были созданы.
4. У вас есть разрешения на изменение настроек вебхука проекта GitLab.

#Настройка вебхука через интерфейс GitLab

1. Перейдите в настройки вашего проекта GitLab.
2. Перейдите в Настройки > Вебхуки.
3. Добавьте URL вебхука в зависимости от режима развертывания EventListener, например, используя режим https:

   https://<ваш-url-eventlistener>
4. Выберите необходимые типы событий:
   • События коммита
   • События запроса на слияние
   • Комментарии
5. (Необязательно) Настройте секретный токен.
6. Нажмите "Добавить вебхук".

#Пример настройки триггера для конвейера

Если цель состоит в том, чтобы реализовать непрерывную интеграцию с помощью триггера с следующими требованиями:

• Автоматически запускать функциональность CI при отправке кода.
• Автоматически запускать конвейер CI при открытии запроса на слияние.

Для упрощения этой документации мы предполагаем, что конвейер готов с предоставленными следующими параметрами:

Далее нам нужно только настроить два триггера ниже:

apiVersion: triggers.tekton.dev/v1alpha1
kind: Trigger
metadata:
    name: my-pipeline-push   # Рекомендуется изменить префикс в зависимости от имени конвейера
    namespace: my-namespace  # Измените на фактическое пространство имен
spec:
    bindings:
    - ref:
        kind: ClusterTriggerBinding
        name: gitlab-push
    template:
      spec:
        params:
        - name: git-revision
        - name: git-repo-url
        resourcetemplates:
        - apiVersion: tekton.dev/v1
          kind: PipelineRun
          metadata:
              generateName: my-pipeline-push- # Рекомендуется изменить префикс в зависимости от имени конвейера
          spec:
              pipelineRef:
                name: my-pipeline  # Измените на фактическое имя конвейера
              params:
              - name: git-revision
                value: $(tt.params.git-revision)
              - name: git-repo-url
                value: $(tt.params.git-repo-url)
              workspaces: # Рабочие пространства нужно изменить в зависимости от требований конвейера и конфигурации окружения
              - name: source
                volumeClaimTemplate:
                  spec:
                    accessModes:
                    - ReadWriteMany
                    resources:
                      requests:
                        storage: 1Gi

kubectl apply -f gitlab-push-trigger.yaml

apiVersion: triggers.tekton.dev/v1alpha1
kind: Trigger
metadata:
  name: my-pipeline-merge-request # Рекомендуется изменить префикс в зависимости от имени конвейера
  namespace: my-namespace # Измените на фактическое пространство имен
spec:
  bindings:
    - ref:
        kind: ClusterTriggerBinding
        name: gitlab-merge-request
  interceptors: # Добавьте Interceptor для фильтрации открытых событий MR, игнорируя остальные на данный момент
  - ref:
      kind: ClusterInterceptor
      name: cel
    params:
    - name: filter
      value: |
        body.object_attributes.state == "opened" &&  body.object_attributes.action == "open"
  template:
    spec:
      params:
        - name: mergereq-sha
        - name: git-repo-url
      resourcetemplates:
      - apiVersion: tekton.dev/v1
        kind: PipelineRun
        metadata:
          generateName: my-pipeline-mr- # Рекомендуется изменить префикс в зависимости от имени конвейера
        spec:
          pipelineRef:
            name: my-pipeline # Измените в соответствии с именем конвейера
          params:
            - name: git-revision
              value: $(tt.params.mergereq-sha)
            - name: git-repo-url
              value: $(tt.params.git-repo-url)
          workspaces: # Рабочие пространства нужно изменить в зависимости от требований конвейера и конфигурации окружения
            - name: source
              volumeClaimTemplate:
                spec:
                  accessModes:
                    - ReadWriteMany
                  resources:
                    requests:
                      storage: 1Gi

kubectl apply -f gitlab-merge-request-trigger.yaml