Readme instructions and event improvements 🔥 (#13)

* helm-charts repo

* merge event

* readme updated

* debug

Author: Gasoid

.gitignore

@@ -1,6 +1,5 @@
 .env
 .vscode
-*.yaml
 _config
 .DS_Store
 _metrics

README.md

@@ -2,7 +2,7 @@
 
 ![screen](screen.webp)
 
-### Features
+## Features
 - rule for title
 - rule for approvals
 - rule for approvers
@@ -11,29 +11,85 @@
 - delete stale branches
 
 
+## Table of Contents
+
+- [Installation](#installation)
+  - [Gitlab Cloud](#gitlab-cloud)
+  - [Docker-compose](#Docker-compose)
+  - [Helm](#helm)
+  - [CLI](#cli)
+- [Config file](#config-file)
+  - [Example](#example)
+  - [Demo project on gitlab](https://gitlab.com/Gasoid/sugar-test)
+- [Required bot permissions](#required-bot-permissions)
+
+### Demo repo
+
+https://gitlab.com/Gasoid/sugar-test
+
 ### Commands
 - !merge
 - !check
 - !update
 
-## Self-hosted or Cloud
+## Installation
 The Bot could be run within your infrastructure as container.
 In case you want to test the bot you can use gitlab cloud bot.
 
-### Self-hosted
+
+### Gitlab Cloud
+1. Invite bot ([@mergeapprovebot](https://gitlab.com/mergeapprovebot)) in your repository as **maintainer** (you can revoke permissions from usual developers in order to prevent merging)
+2. Add webhook `https://mergebot.tools/mergebot/webhook/gitlab/your_username_or_company_name/repo-name/` (Comments and merge request events)
+3. PROFIT: now you can create MR, leave commands: !check and then !merge (comment in MR)
+
+You can test bot on gitlab public repo: https://gitlab.com/Gasoid/sugar-test
+
+### Docker-compose
 
 1. bot.env:
 ```
 GITLAB_TOKEN="your_token"
 #TLS_ENABLED="false"
 #TLS_DOMAIN="domain.your-example.com"
+#GITLAB_URL=""
 ```
 
 2. run docker-compose
 ```
 docker-compose up -d
 ```
 
+
+### Helm
+
+[Helm](https://helm.sh) must be installed to use the charts.  Please refer to
+Helm's [documentation](https://helm.sh/docs) to get started.
+
+Once Helm has been set up correctly, add the repo as follows:
+
+    helm repo add merge-bot https://gasoid.github.io/helm-charts
+
+If you had already added this repo earlier, run `helm repo update` to retrieve
+the latest versions of the packages.  You can then run `helm search repo merge-bot` to see the charts.
+
+To install the merge-bot chart:
+
+    helm install my-merge-bot merge-bot/merge-bot
+
+To uninstall the chart:
+
+    helm uninstall my-merge-bot
+
+### CLI
+
+Create personal/repo/org token in gitlab, copy it and set as env variable
+```bash
+export GITLAB_TOKEN="your_token"
+export GITLAB_URL="" # if it is not public gitlab cloud
+export TLS_ENABLED="true"
+export TLS_DOMAIN="bot.domain.com"
+```
+
 you can configure bot using cli args as well:
 ```bash
 Usage of merge-bot:
@@ -49,32 +105,11 @@ Usage of merge-bot:
     	whether tls enabled or not, bot will use Letsencrypt, default is false (also via TLS_ENABLED)
 ```
 
-### Setup for Gitlab Cloud
-1. Invite bot ([@mergeapprovebot](https://gitlab.com/mergeapprovebot)) in your repository as **maintainer** (you can revoke permissions from usual developers in order to prevent merging)
-2. Add webhook `https://mergebot.tools/mergebot/webhook/gitlab/your_username_or_company_name/repo-name/` (Comments and merge request events)
-3. PROFIT: now you can create MR, leave commands: !check and then !merge (comment in MR)
-
-### Quickstart on your env
-
-Create personal/repo/org token in gitlab, copy it and set as env variable
-```bash
-export GITLAB_TOKEN="your_token"
-export GITLAB_URL="" # if it is not public gitlab cloud
-export TLS_ENABLED="true"
-export TLS_DOMAIN="bot.domain.com"
-```
-
 Run bot
 ```
 go run ./
 ```
 
-### Build
-```
-go build ./
-```
-
-
 
 ## Config file
 
@@ -102,7 +137,7 @@ stale_branches_deletion:
   days: 90 # branch is staled after int days, default is 90
 ```
 
-Example:
+#### Example:
 
 ```yaml
 approvers:
@@ -123,3 +158,7 @@ stale_branches_deletion:
 ```
 
 place it in root of your repo and name it `.mrbot.yaml`
+
+### Required bot permissions
+- Bot must have __Maintainer__ role in order to comment, merge and delete branches
+- Access Token must have following permissions: api, read_repository, write_repository

bot.go

@@ -81,12 +81,17 @@ func Handler(c echo.Context) error {
 		go func() {
 			command, err := handlers.New(providerName)
 			if err != nil {
-				slog.Error("can't initialize provider", "provider", providerName, "command", command, "err", err)
+				slog.Error("can't initialize provider", "provider", providerName, "event", hook.Event, "err", err)
 				return
 			}
 
+			// if err := command.LoadInfoAndConfig(hook.GetProjectID(), hook.GetID()); err != nil {
+			// 	slog.Error("can't load repo config", "provider", providerName, "command", command, "err", err)
+			// 	return
+			// }
+
 			if err := f(command, hook); err != nil {
-				slog.Error("handlerFunc returns err", "provider", providerName, "command", command, "err", err)
+				slog.Error("handlerFunc returns err", "provider", providerName, "event", hook.Event, "err", err)
 			}
 		}()
 	}

bot_test.go

@@ -11,18 +11,13 @@ import (
 )
 
 type testWebhookProvider struct {
-	isNew     bool
 	isValid   bool
 	id        int
 	projectID int
 	cmd       string
 	err       error
 }
 
-func (p *testWebhookProvider) IsNew() bool {
-	return p.isNew
-}
-
 func (p *testWebhookProvider) IsValid() bool {
 	return p.isValid
 }

commands.go

@@ -12,6 +12,7 @@ func init() {
 	handle("!check", CheckCmd)
 	handle("!update", UpdateBranchCmd)
 	handle(webhook.OnNewMR, NewMR)
+	handle(webhook.OnMerge, MergeEvent)
 }
 
 func UpdateBranchCmd(command *handlers.Request, hook *webhook.Webhook) error {
@@ -55,3 +56,11 @@ func NewMR(command *handlers.Request, hook *webhook.Webhook) error {
 
 	return nil
 }
+
+func MergeEvent(command *handlers.Request, hook *webhook.Webhook) error {
+	if err := command.DeleteStaleBranches(hook.GetProjectID(), hook.GetID()); err != nil {
+		return fmt.Errorf("command.MergeEvent returns err: %w", err)
+	}
+
+	return nil
+}

handlers/checkers.go

@@ -51,11 +51,11 @@ var (
 			checkFunc: checkDescription,
 		},
 		{
-			text:      "Number of approvals",
+			text:      "Number of approvals (mr author is ignored)",
 			checkFunc: checkApprovals,
 		},
 		{
-			text:      "Required approvers",
+			text:      "Required approvers (mr author is ignored)",
 			checkFunc: checkApprovers,
 		},
 		{

handlers/gitlab/gitlab.go

@@ -144,7 +144,7 @@ func (g *GitlabProvider) IsValid(projectId, mergeId int) (bool, error) {
 	}
 
 	if g.mr.State != "opened" {
-		return false, handlers.StatusError
+		return false, nil
 	}
 
 	return !g.mr.HasConflicts, nil

handlers/request.go

@@ -113,6 +113,18 @@ func (r *Request) Greetings(projectId, id int) error {
 	return r.LeaveComment(projectId, id, buf.String())
 }
 
+func (r *Request) DeleteStaleBranches(projectId, id int) error {
+	if err := r.LoadInfoAndConfig(projectId, id); err != nil {
+		return err
+	}
+
+	if r.config.StaleBranchesDeletion.Enabled {
+		return r.cleanStaleBranches(projectId)
+	}
+
+	return nil
+}
+
 func (r *Request) Merge(projectId, id int) (bool, string, error) {
 	if err := r.LoadInfoAndConfig(projectId, id); err != nil {
 		return false, "", err
@@ -125,10 +137,6 @@ func (r *Request) Merge(projectId, id int) (bool, string, error) {
 		}
 	}
 
-	if r.config.StaleBranchesDeletion.Enabled {
-		defer r.cleanStaleBranches(projectId)
-	}
-
 	if ok, text, err := r.IsValid(projectId, id); ok {
 		if err := r.provider.Merge(projectId, id, fmt.Sprintf("%s\nMerged by MergeApproveBot", r.info.Title)); err != nil {
 			return false, "", err

handlers/stalebranches.go

@@ -1,6 +1,7 @@
 package handlers
 
 import (
+	"fmt"
 	"log/slog"
 	"time"
 )
@@ -10,11 +11,12 @@ type Branch struct {
 	LastUpdated time.Time
 }
 
-func (r *Request) cleanStaleBranches(projectId int) {
+func (r *Request) cleanStaleBranches(projectId int) error {
+	slog.Debug("deletion of stale branches has been run")
+
 	candidates, err := r.provider.ListBranches(projectId)
 	if err != nil {
-		slog.Error("ListBranches returns error", "err", err)
-		return
+		return fmt.Errorf("ListBranches returns error: %w", err)
 	}
 
 	days := r.config.StaleBranchesDeletion.Days
@@ -26,8 +28,9 @@ func (r *Request) cleanStaleBranches(projectId int) {
 			// delete branch
 			slog.Debug("branch info", "name", b.Name, "createdAt", b.LastUpdated.String())
 			if err := r.provider.DeleteBranch(projectId, b.Name); err != nil {
-				slog.Error("DeleteBranch returns error", "branch", b.Name, "err", err)
+				return fmt.Errorf("DeleteBranch returns error: %w", err)
 			}
 		}
 	}
+	return nil
 }

webhook/gitlab/gitlab.go

@@ -67,17 +67,23 @@ func (g *GitlabProvider) ParseRequest(request *http.Request) error {
 }
 
 func (g *GitlabProvider) GetCmd() string {
+	slog.Debug("getCmd", "action", g.action)
+
+	if g.action == "merge" {
+		return webhook.OnMerge
+	}
+
+	if g.action == "open" {
+		return webhook.OnNewMR
+	}
+
 	slog.Debug("getCmd", "note", g.note)
 	if strings.HasPrefix(g.note, "!") {
 		return g.note
 	}
 	return ""
 }
 
-func (g *GitlabProvider) IsNew() bool {
-	return g.action == "open"
-}
-
 func (g *GitlabProvider) GetID() int {
 	return g.id
 }