Skip to main content
Add MergeGuide to GitLab CI with the official template. It runs your policy checks on merge request pipelines and produces a GitLab SAST report so findings appear on the merge request.

​
Include the template

Add the MergeGuide template to your .gitlab-ci.yml and use the job it defines:
.gitlab-ci.yml

​
Template inputs

The template accepts these inputs:

​
SAST report on merge requests

The job writes a SAST report (mergeguide-results.json) and attaches it as a GitLab sast artifact, so findings surface in the merge request’s security widget. The report artifact is retained for one week by default.

​
Block merges on findings

To prevent a merge while findings block, leave allow_failure at its default (false) and configure the merge request to require a passing pipeline in your project’s Settings → Merge requests. See Set up the PR gate.

​
Next steps

PR gate

Block merges on blocking findings.

CI/CD patterns

Wire MergeGuide into any pipeline.