Skip to main content
2 video tutorials

Merge Pilot documentation

Merge Pilot is a change management gate for merge requests on GitLab and GitHub. It decides which merge requests need a change approval, runs the checks your change policies ask for, opens the change approval in Jira or its built-in tracker, and keeps the merge blocked on the VCS until the policy is met for the merge request's latest commit.

How a merge request goes through Merge Pilot​

  1. GitLab or GitHub sends the merge request to Merge Pilot by webhook.
  2. The first active change policy that matches it covers it. The policy's change type is standard (checks only), normal (checks and a change approval) or emergency (may merge before the approval; reviewed afterwards).
  3. The policy's controls run: work items, code review, CI, secret scan, dependency scan, licenses, package health, dependency sources, CI configuration check, container image scan, infrastructure check, signed commits, risk, change freeze and approval. Each control is off, reported or enforced.
  4. For a change that needs one, a change approval is opened in the company's tracker and assigned to someone who may decide it. The author never may.
  5. Approvers decide in the tracker or in Merge Pilot.
  6. Merge Pilot opens the merge gate on the VCS: a passing check on GitHub, the bot user's approval on GitLab. A new commit needs a new decision before it can merge.

Who these pages are for​

  • Platform admins run the Merge Pilot instance and its companies.
  • Company administrators connect GitLab, GitHub and Jira, and set up repositories, policies and people.
  • Policy managers write change policies.
  • Approvers and developers work with merge requests and change approvals.

Every setting is described with its label in the interface, its default and its limits, as the product behaves.

Where to start​

  • Core concepts: the words the rest of the documentation uses.
  • Platform administration: roles and users, platform settings, sign-in, identity providers, the company directory, API tokens, the audit log and background jobs.
  • Connections: GitLab, GitHub, Jira and the built-in tracker, and what each connection lets people do.
  • Change policies: which policy covers a merge request, how policies match, and every control field by field.
  • Companies: a company's settings, tab by tab.
  • Repositories: watching repositories, putting them under change management, bulk operations, direct changes and the project page.
  • Merge requests: the merge request pages, the merge gate, the change approval lifecycle, voting, what happens in each situation and re-running checks.
  • Security: the vulnerability inventory, exceptions, project analysis, secret findings and SBOM export.
  • Insights: the dashboard, My work, DORA metrics, the change calendar, the monitoring report and the compliance report.
  • Built-in tracker: the board, issues, workflows and project settings, and tracker issues as work items.
  • Notifications: Slack, Teams and email channels, the events, routes, personal emails, the delivery log and outbound webhooks.
  • REST API: authentication, conventions, examples and the endpoint-by-endpoint reference.
  • Troubleshooting: what a message means and what to do, by area. See also the FAQ and the glossary.

Video tutorials

Short videos of this feature working on real GitLab and Jira projects. English audio, English and Turkish subtitles. All video tutorials →

Sign In and Create Your CompanyYouTube ↗
Follow One Merge Request Through the GateYouTube ↗