GitLab¶

GitLab event-source programmatically configures webhooks for projects on GitLab and helps sensor trigger the workloads upon events.

Event Structure¶

The structure of an event dispatched by the event-source over the eventbus looks like following,

        {
            "context": {
              "type": "type_of_event_source",
              "specversion": "cloud_events_version",
              "source": "name_of_the_event_source",
              "id": "unique_event_id",
              "time": "event_time",
              "datacontenttype": "type_of_data",
              "subject": "name_of_the_configuration_within_event_source"
            },
            "data": {
               "body": "Body is the GitLab event data",
               "headers": "Headers from the GitLab event",
            }
        }

Specification¶

GitLab event-source specification is available here.
Example event-source yaml file is here.

Setup¶

Create an API token if you don't have one. Follow instructions to create a new GitLab API Token. Grant it the api permissions.
Base64 encode your api token key.
```
echo -n <api-token-key> | base64
```

Create a secret called gitlab-access.

apiVersion: v1
kind: Secret
metadata:
  name: gitlab-access
type: Opaque
data:
  token: <base64-encoded-api-token-from-previous-step>

Deploy the secret into K8s cluster.

kubectl -n argo-events apply -f gitlab-access.yaml

The event-source for GitLab creates a pod and exposes it via service. The name for the service is in <event-source-name>-eventsource-svc format. You will need to create an Ingress or OpenShift Route for the event-source service so that it can be reached from GitLab. You can find more information on Ingress or Route online.
Create the event source by running the following command. Make sure to update url field.
```
kubectl apply -n argo-events -f <event-source-file-updated-in-previous-step>
```
Go to Webhooks under your project settings on GitLab and verify the webhook is registered.

Create the sensor by running the following command.

kubectl apply -n argo-events -f https://raw.githubusercontent.com/argoproj/argo-events/stable/examples/sensors/gitlab.yaml

Make a change to one of your project files and commit. It will trigger an argo workflow.
Run argo list to find the workflow.

Event Types¶

The GitLab event-source supports the following event types: - PushEvents - Push events - TagPushEvents - Tag push events - IssuesEvents - Issue events (create, update, close, reopen) - ConfidentialIssuesEvents - Confidential issue events - MergeRequestsEvents - Merge request events - ConfidentialNoteEvents - Confidential comment events - NoteEvents - Comment events - JobEvents - Pipeline job events - PipelineEvents - Pipeline events - WikiPageEvents - Wiki page events - EmojiEvents - Emoji reaction events on issues, merge requests, snippets, and comments

EmojiEvents Support¶

EmojiEvents is supported for both project and group webhooks. The event is triggered when users add emoji reactions to issues, merge requests, snippets, or comments.

Project webhook example:

gitlab:
  example:
    projects:
      - "my-project"
    events:
      - IssuesEvents
      - MergeRequestsEvents
      - EmojiEvents

Group webhook example:

gitlab:
  example:
    groups:
      - "my-group-name"
    events:
      - IssuesEvents
      - MergeRequestsEvents
      - EmojiEvents

Note: Group webhooks receive emoji events from all projects within the group

For more details, see GitLab Webhooks Documentation.

Troubleshoot¶

Please read the FAQ.