Skip to content

Commit 1e3a4f9

Browse files
authored
Readme improvements (#59)
1 parent f4f4dc9 commit 1e3a4f9

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
[![Build Status](https://travis-ci.org/pepakriz/gitlab-merger-bot.svg)](https://travis-ci.org/pepakriz/gitlab-merger-bot)
44

5+
## What does it do?
6+
7+
The goal is to have green master after every merge. To achieve this you must rebase every single merge request just before the merge and wait for pipeline status. It takes a lot of time of manual maintenance. So let's automate it with GitLab MergerBot.
8+
9+
1) When you merge request is ready to merge, assign it to the bot.
10+
2) The bot will add your request to its own serial (FIFO) queue. (single queue for every repository)
11+
3) When your request is on the turn, the bot will rebase the MR and start waiting for the pipeline.
12+
4) When the bot detects some problems with the merge request it'll reassign the merge request back to the author.<br />
13+
Reasons can be for example:
14+
- Failing pipeline or pipeline awaiting for a manual action
15+
- The merge request has unresolved discussions
16+
- The merge request can't be rebased due to conflict
17+
18+
![Assign](https://i.imgur.com/B3Xnpgi.png)
19+
![Merged](https://i.imgur.com/N0WhuOU.png)
520

621
## Pre-Installation requirements
722

@@ -11,7 +26,7 @@
1126
2) Sign-in to GitLab as bot-user and go to [https://gitlab.com/profile/personal_access_tokens](https://gitlab.com/profile/personal_access_tokens)
1227
3) Add new personal access token with `api` scope
1328

14-
> We strongly recommend using a separate account for bot-user. Don't reuse existing account which can leave the project in future.
29+
> We strongly recommend using a separate account for bot-user. Don't reuse existing account which can leave the project in the future.
1530
1631
#### Setup GitLab repository
1732

0 commit comments

Comments
 (0)