General tab
The General tab holds what identifies the company and what it covers: its name, its time zone, whether it is active, and the branches whose merge requests Merge Pilot follows.
Company page → General. Company admins of the company and platform admins change these settings, except Active, which only platform admins change; they are saved with Save changes (see Saving). None of them is held for four-eyes review.
Settings
| Setting (label in the UI) | What it does | Default | Allowed values | Who can change it | API field |
|---|---|---|---|---|---|
| Name | The company's name, shown in the company selector, on the company page and on the Companies page. Change approval templates can use it | Set when the company is created | Any text, required (Name is required; a blank name is refused with 400) | Company admin, platform admin | name |
| Slug | Part of the company's webhook URLs, so it does not change. Made from the name when the company is created; renaming the company keeps it | From the name | Read-only | Nobody | slug |
| Description | A note shown on the Companies page | Empty | Any text | Company admin, platform admin | description |
| Time zone | The company's time zone (IANA name, e.g. Europe/Istanbul or UTC). Change windows, change freezes and the change calendar use it. The audit report's days are in it too | Empty: UTC | Empty, or an IANA time zone name, such as Europe/Istanbul, America/New_York or UTC. Anything else is refused: the form says Enter a time zone name, such as Europe/Istanbul or UTC, the API answers 400 | Company admin, platform admin | timezone |
| Active | An inactive company's webhooks are ignored, its people cannot sign in and nothing of it is processed. See Deactivating a company for what stops. For company admins the switch is disabled: Only platform admins turn a company off or on. | On | On, off | Platform admin (the API answers 403 when anyone else turns the company off) | active |
| Branch patterns | The branches whose merge requests Merge Pilot follows. See Branch patterns | Repository default branch | At least one branch or pattern (Branch patterns cannot be empty. At least one pattern is required.) | Company admin, platform admin | branch_patterns |
| Production branches for DORA | The branches whose merges DORA counts as deployments: Repository default branch, main, master, and other names or patterns such as release/* | Empty: each repository's default branch | Branch names and patterns; a blank entry is refused | Company admin, platform admin | dora_production_branches |
Turning the company off
Switching Active off asks first: Deactivate the company? (Once saved, all webhooks and processing for this company stop until it is active again.), with Deactivate. Nothing changes until Save changes.
Only a platform admin turns a company off (here, or from the Companies page) and back on (here). When the company is saved as inactive, everyone of the company is signed out.
Branch patterns
The branch patterns name the target branches Merge Pilot follows: a merge request into another branch is not evaluated, and putting a repository under change management protects these branches, so that they change only through approved merge requests.
The field has three quick choices and a list:
- Repository default branch: each repository's own default branch, whatever it is called (
main,master,develop…). Stored as~DEFAULT_BRANCH. - main, master: these branch names.
- Other branches or patterns: any other branch or pattern your changes go through before production, such as
prod-release,release/*orhotfix/**. Press Enter (or type a comma) after each.
Patterns are matched as in policies, against the whole branch name and case-sensitively (see Matching): release/* matches release/v1.0 but not release/v1/hotfix; hotfix/** matches both hotfix/a and hotfix/a/b.
A project may set its own target branches; it then uses those instead of the company's (see The project page).
When the branch patterns change, Merge Pilot updates the webhook of every registered repository of the company in the background, a batch at a time (the events_sync job, see Jobs).
In the API, branch_patterns is a list of strings; an empty list is refused with 400. A company created without patterns gets ["~DEFAULT_BRANCH"].
API
PUT /api/v1/companies/{id} with any of name, description, timezone, active and branch_patterns; the fields left out keep their values. See Company API.
Related pages
- Companies: the company page, saving and the company API.
- Change calendar: change windows and change freezes, which use the time zone.
- Change management: how the branch patterns are protected.
- Matching: branch pattern syntax.
Video tutorial
Short videos of this feature working on real GitLab and Jira projects. English audio, English and Turkish subtitles. All video tutorials →