How to run pipeline after merge request approved in Gitlab CI?

Question

I want GitLab CI to run a job after a merge request is merged. I don't want it to be run on CREATING a new merge request and also I don't want it to be run whenever target branch is updated. (Since it's possible to commit directly to target branch and the job should not be run in that situation.)

Is that possible?

If yes, I also want to know informations about the merge request which triggered the job.

(Actually I want to update my project management system, when a merge request is merged. Thus I need to know which merge request is merged (or approved).)

Thanks in advance.

Does this answer your question? [Gitlab run a pipeline job when a merge request is merged](https://stackoverflow.com/questions/63893431/gitlab-run-a-pipeline-job-when-a-merge-request-is-merged) — Sty, Jan 10 '22 at 16:41

score 7 · Answer 1 · edited Sep 13 '22 at 16:37

7

I want GitLab CI to run a job after a merge request is merged.

Unfortunately, GitLab does not offer a "merge request merged" trigger.

What you can do, is to make the pipeline run for any push in a certain branch and use branch-protection to make sure pushs can only come from merge requests. To do that:

Set your pipeline to only run e.g. for branch main:

# if you want to use "only":
my_job: 
  only:
    - main

# or alternatively if you want to use rules you can do the same with: 
my_job:
  rules:
    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_REF_NAME == "master"'

Enable Branch protection to disable direct pushes to main and only allow MRs:

edited Sep 13 '22 at 16:37

Josh Correia

3,807
3
33
50

answered Jan 12 '22 at 15:55

uupascal

531
4
6

Can you please add more details here... – sri05 Mar 09 '22 at 08:42
I've added more details. Hope it helps. – uupascal Mar 10 '22 at 09:30
`if: '$CI_PIPELINE_SOURCE == "push" && $CI_BUILD_REF_NAME == "master"'` doesn't work. Nothing is triggered for me. Did I miss something? – Lucas Willems May 23 '22 at 08:46
1

@LucasWillems the following should work. It works for me on GitLab 15.1, at least. `if: $CI_COMMIT_BRANCH == "main"` – Liam Jul 12 '22 at 08:47
will this fail the merge if the pipeline breaks? How does it relates to https://docs.gitlab.com/ee/ci/pipelines/merged_results_pipelines.html ? – Hanan Shteingart Feb 26 '23 at 18:52

Mohammad Shawer Khandariya · Answer 2 · 2022-11-04T06:38:16.973

2

You can run the pipeline after merge by using Gitlab ci predefined variable $CI_MERGE_REQUEST_APPROVED this will return true after merge has been done and available from gitlab v14.1.

you can add the rule like this in your job.

rules:
  - if: $CI_MERGE_REQUEST_APPROVED

edited Nov 04 '22 at 06:38

answered Nov 04 '22 at 05:18

Mohammad Shawer Khandariya

9
3

1

Using $CI_MERGE_REQUEST_APPROVED is not what should be used for this question. $CI_MERGE_REQUEST_APPROVED becomes true if someone approves a merge request, not if the MR is merged. An MR can be approved and not yet merged. – mdailey77 Jun 28 '23 at 14:10

score 0 · Answer 3 · answered Apr 28 '23 at 20:55

Not sure why this isn't mentioned before, but I was able to achieve what I wanted by leveraging the Environment on_stop event.

Set up the pipeline to only run under the MR context
Have an environment that's tied to the MR
Set up on_stop event for the environment for the MR to run a stage, e.g. "OnStop"
Put whatever you want to be triggered in the "OnStop" stage

https://docs.gitlab.com/ee/ci/yaml/#environmenton_stop

score 0 · Answer 4 · answered Jul 27 '23 at 12:11

This might be the rules to control your job

job:
   rules:
     - if : '$CI_PIPELINE_SOURCE == "merge_request_event" || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_COMMIT_BRANCH '
       when: never
     - if: $CI_COMMIT_TITLE =~ /Merge branch.*/
       when: on_success
   script:
     - echo "the merge request which has done has the ID $CI_MERGE_REQUEST_IID"
     # other scripts to run your job

the value of CI_MERGE_REQUEST_IID in format of !number will be shown in merge requests left-side menu in ui gitlab, as well as jobs and pipelines list. I guess you can use this id number to verify which merge request has done successfully.

How to run pipeline after merge request approved in Gitlab CI?

4 Answers4

Linked