Feat : gitlab ci support #1061

ManilDf · 2025-05-29T13:13:30Z

This PR implements the integration of notifying from Gitlab pipelines when triggering and when they finished.

Signed-off-by: madjidDer <dermelmadjid@gmail.com>

Half-Shot · 2025-05-30T20:20:31Z

This is super exciting! Massive props to doing comprehensive tests for this too :)

Signed-off-by: madjidDer <dermelmadjid@gmail.com>

Half-Shot · 2025-06-03T07:51:07Z

@ManilDf are you happy for this to be undrafted?

Half-Shot

This is really, really fantastic folks. Thank you for spending the time to do some proper tests for this and getting this to 99% of the way.

So I just have a few minor nits, mainly that we need to support the subtypes of pipeline so that users may filter on which kinds of pipeline event. E.g. We like to use .failed a lot at Element because we can detect failing automations.

Otherwise, keep it up and ping me when ready!

changelog.d/1061.feature

Half-Shot · 2025-06-03T07:55:23Z

src/Connections/GitlabRepo.ts

+    const { status, ref, duration, id: pipelineId } = event.object_attributes;
+
+    const statusUpper = status.toUpperCase();
+    if (!this.notifiedPipelines.has(pipelineId)) {


Is this likely to trigger multiple times?

Thank you for your comment. You're right — the handler is currently being called multiple times due to the various statuses within a single pipeline.

To address this, we’ll create separate handlers for each pipeline sub-type (e.g., pipeline.success, pipeline.triggered). This will allow us to remove the conditional check currently in place

Half-Shot · 2025-06-03T07:56:32Z

src/Connections/GitlabRepo.ts

@@ -97,7 +98,8 @@ type AllowedEventsNames =
  | "wiki"
  | `wiki.${string}`
  | "release"
-  | "release.created";
+  | "release.created"
+  | "pipeline";


According to the docs we have:

- pipeline.triggered \* - pipeline.canceled \* - pipeline.failed \* - pipeline.success \*

so we should include these here.

Alright, we’ll proceed with the update once the individual handlers have been created

Half-Shot · 2025-06-03T07:57:06Z

src/Connections/GitlabRepo.ts

@@ -971,6 +976,53 @@ ${data.description}`;
    });
  }

+  public async onPipelineEvent(event: IGitLabWebhookPipelineEvent) {
+    if (this.hookFilter.shouldSkip("pipeline")) {


As per docs, we should properly filter on the subtypes of pipeline.*?

Yes, it will also be updated when handlers will be created

Half-Shot · 2025-06-03T07:57:56Z

src/gitlab/WebhookTypes.ts

+  };
+  object_attributes: {
+    id: number;
+    status: string;


Would it be possible to enumerate all the possible values of status here? E.g.

Suggested change

status: string;

status: "triggered"|"success";

etc etc?

Half-Shot · 2025-06-03T07:59:01Z

tests/connections/GitlabRepoTest.ts

+
+      expect(intent.sentEvents[1].content.body).to.include("SUCCESS");
+      expect(intent.sentEvents[1].content.formatted_body).to.include(
+        '<font color="green"><b>SUCCESS</b></font>',


N.B. As per the Matrix spec we now prefer a <span> with data-mx-color https://spec.matrix.org/latest/client-server-api/#mroommessage-msgtypes

leguye · 2025-06-06T15:48:00Z

Hi @Half-Shot,

Thank you for your encouraging feedback and for un-drafting the PR. We are thrilled to see your positive comments.

@ManilDf and @madjidDer are currently occupied with other commitments but plan to address your suggestions next week.

We'll notify you once the updates are ready for review.

Co-authored-by: Will Hunt <github@half-shot.uk> Signed-off-by: Manil Diaf <152652065+ManilDf@users.noreply.github.com>

…x-org#1062) * Add warning for failing to reach HS * Update types * fixup test * tweaks * lint

…ric hooks (matrix-org#1004) * Add an option at the config and state level to disable hook bodies. * add a test * changelog * no fake requried * default to state, then config for data inclusion * default to including webhook state * allow undefined * update new config * update tests * document

…/webhook` (matrix-org#1063) * Refactor and migrate webhook paths forGitHub * changelog * begin moving Gitlab * Test both paths on GitHub * Add tests for GitLab. * Move JIRA webhook handling to router * Update docs with new webhook info. * Use /webhook for path * lint

Signed-off-by: Will Hunt <will@half-shot.uk>

Hakim-Lakrout · 2025-06-07T11:48:57Z

We have to update the codebase when resolving the conflict to use the new Router.ts in main branch to redirect to the Gitlab events.

Signed-off-by: LAKROUT Hakim <99540145+Hakim-Lakrout@users.noreply.github.com>

Half-Shot · 2025-06-09T10:20:52Z

The docker fails are #1023 and can be ignored. Sorry about the refactor from underneath you. When the linter passes I'll do another review and merge if all good.

Hakim-Lakrout · 2025-06-09T10:29:29Z

The docker fails are #1023 and can be ignored. Sorry about the refactor from underneath you. When the linter passes I'll do another review and merge if all good.
Hi! Thanks for your reply. We still have a few adjustments to make, but it should be ready for review by the end of the day.

Half-Shot

Handful of cleanup tasks

src/Connections/GitlabRepo.ts

Half-Shot · 2025-06-09T15:32:57Z

src/Connections/GitlabRepo.ts

+    );
+    const { ref, duration } = event.object_attributes;
+
+    const contentText = `Pipeline SUCCESS on branch \`${ref}\` for project ${event.project.name} by ${event.user.username} - Duration: ${duration ?? "?"}s`;


If duration isn't present, I'd just leave it off entirely. Duration: ?s reads a bit weird to me.

Half-Shot · 2025-06-09T15:33:35Z

src/HookFilter.ts

@@ -24,6 +24,7 @@ export class HookFilter<T extends string> {

  public shouldSkip(...hookName: T[]) {
    // Should skip if all of the hook names are missing
+    //console.log("→ shouldSkip called with", hookName, "vs", this.enabledHooks);


src/gitlab/Router.ts

Half-Shot · 2025-06-09T15:35:23Z

web/components/roomConfig/GitlabRepoConfig.tsx

+          <EventHookCheckbox
+            enabledHooks={enabledHooks}
+            hookEventName="pipeline"
+            onChange={toggleEnabledHook}


N.B. needs to have the subcategories like "Merge requests" does above.

Remove unused type Co-authored-by: Will Hunt <github@half-shot.uk> Signed-off-by: LAKROUT Hakim <99540145+Hakim-Lakrout@users.noreply.github.com>

Fix typo Co-authored-by: Will Hunt <github@half-shot.uk> Signed-off-by: LAKROUT Hakim <99540145+Hakim-Lakrout@users.noreply.github.com>

Update current branch

Hakim-Lakrout · 2025-06-16T06:43:53Z

Hi @Half-Shot , just following up on this pull request, do you have any updates or feedback?

Half-Shot · 2025-06-23T07:46:10Z

Hi @Half-Shot , just following up on this pull request, do you have any updates or feedback?

Hey sorry for the delay, I was off from work some of last week. Catching up now.

madjidDer and others added 11 commits May 20, 2025 12:48

Support GitLab pipeline events

2d477e1

Tests

3b6f188

test: refactor pipeline event tests using loop

f784f73

ignore intermediate pipeline statuses

5595e18

Update pipeline tests and tweak message formatting

45b8bfa

Add e2e Tests

b93b0bd

handle CANCELED status and deduplicate notifications

a7b9a06

Merge branch 'main' into feat/gitlab-ci-support

34051aa

docs: mention GitLab pipeline event in supported hooks

13deb0a

Add changelog

165cb88

Signed-off-by: madjidDer <dermelmadjid@gmail.com>

remove comments

eeff431

Signed-off-by: madjidDer <dermelmadjid@gmail.com>

Half-Shot self-requested a review May 30, 2025 20:19

Fix lint issues

0559e53

Signed-off-by: madjidDer <dermelmadjid@gmail.com>

Half-Shot requested changes Jun 3, 2025

View reviewed changes

Half-Shot marked this pull request as ready for review June 5, 2025 09:08

Half-Shot requested a review from a team as a code owner June 5, 2025 09:08

ManilDf and others added 9 commits June 6, 2025 20:53

Update changelog.d/1061.feature

f960f23

Co-authored-by: Will Hunt <github@half-shot.uk> Signed-off-by: Manil Diaf <152652065+ManilDf@users.noreply.github.com>

Fix tests by adding missing type

92f24b5

refactor: add first handler for pipeline.success

2fe82a5

Ping homeserver on startup and warn about configuration errors (matri…

0112b90

…x-org#1062) * Add warning for failing to reach HS * Update types * fixup test * tweaks * lint

jira webhook docs fix

f00e17b

Signed-off-by: Will Hunt <will@half-shot.uk>

Support GitLab pipeline events

8ad832c

refactor: add first handler for pipeline.success

a25430c

move gitlab pipeline mapping to Route.ts

503caa3

Hakim-Lakrout and others added 2 commits June 7, 2025 15:19

Merge branch 'main' into feat/gitlab-ci-support

92c1419

Signed-off-by: LAKROUT Hakim <99540145+Hakim-Lakrout@users.noreply.github.com>

Fix lint issues

a46ae17

Half-Shot self-requested a review June 9, 2025 10:20

fix: issues and refactor code, address comments

dd908ba

Half-Shot requested changes Jun 9, 2025

View reviewed changes

Hakim-Lakrout and others added 5 commits June 9, 2025 18:24

Update src/Connections/GitlabRepo.ts

37cef84

Remove unused type Co-authored-by: Will Hunt <github@half-shot.uk> Signed-off-by: LAKROUT Hakim <99540145+Hakim-Lakrout@users.noreply.github.com>

Update src/gitlab/Router.ts

8ea8e71

Fix typo Co-authored-by: Will Hunt <github@half-shot.uk> Signed-off-by: LAKROUT Hakim <99540145+Hakim-Lakrout@users.noreply.github.com>

Fix tsx format for pipeline and remove comment and duration when unused

090b849

Add contributor

3874c7f

Merge branch 'main' into feat/gitlab-ci-support

ed5c542

Update current branch

Half-Shot self-requested a review June 12, 2025 14:37

Merge branch 'main' into feat/gitlab-ci-support

81c5bff

Feat : gitlab ci support #1061

Are you sure you want to change the base?

Feat : gitlab ci support #1061

Uh oh!

Conversation

ManilDf commented May 29, 2025

Uh oh!

Half-Shot commented May 30, 2025

Uh oh!

Half-Shot commented Jun 3, 2025

Uh oh!

Half-Shot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leguye commented Jun 6, 2025

Uh oh!

Hakim-Lakrout commented Jun 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Half-Shot commented Jun 9, 2025

Uh oh!

Hakim-Lakrout commented Jun 9, 2025

Uh oh!

Half-Shot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hakim-Lakrout commented Jun 16, 2025

Uh oh!

Half-Shot commented Jun 23, 2025

Uh oh!

Uh oh!

Hakim-Lakrout commented Jun 7, 2025 •

edited

Loading