niklasstoffers / gitlab-auto-approve Goto Github PK

Credits to Github Giphy

Gitlab Auto Approve is a Gitlab bot for automatically approving merge requests. It's built based on FastAPI.

This bot is still in development. Version v0.1.0 will be out soon

This bot currently only supports automatic approval and disapproval of merge requests upon receiving configureable user comments within the gitlab merge request. If you are missing further features please open a new issue.

Due to limitations in the Gitlab API approval commands can only be used with a Premium or Ultimate Tier instance. This bot was primarily tested for Gitlab version v16.7.0. If you encounter issues with a different Gitlab version please open a new issue.

To setup a new instance of this bot you can either clone the repository and run the application on your own using the instructions below or use a prebuilt docker image that can be found here.

If you want to use the prebuilt docker image from Docker Hub, please follow the steps below.

1. Pull the image from docker hub with docker pull niklasstoffers/gitlab-auto-approve:latest
2. Configure the bot via environment variables as described here
3. Run the image with docker

If you don't want to use the prebuilt docker image from Docker Hub, but instead want to build the image yourself, please follow the steps below.

1. Clone the repository
2. Make sure that you have docker and docker-compose installed. If you want to use the Makefile thats shipped with this repository please also make sure that you have installed make.
3. Configure the bot via environment variables as described here
4. Build and run the image
   • Using make:

     make build
     make run

   • Without make:

     docker-compose --env-file .env.docker build
     docker-compose --env-file .env.docker up

You can also setup a new instance without using Docker. To do this you will need to have Python3 installed on your machine.

1. Clone the repository
2. Configure the bot via the autoapprove/config.yaml file as described here
3. Run the following commands in your terminal

   cd autoapprove
   python3 -m venv .venv
   source .venv/bin/activate
   pip install -r requirements.txt
   python main.py

To integrate this bot with your gitlab repository you will need Maintainer access to your project.

1. Head over to the projects Access Token settings and create a new access token with the api scope and necessary role to be able to approve the merge request. This role will depend on your project settings.

You can use the following configuration options to configure the bot to your specific needs. The bot accepts both configuration via the autoapprove/config.yaml file as well as environment variables. Environment variable configuration will override configuration in the autoapprove/config.yaml file.

To use HTTPS with the bot you will need to enable SSL via the configuration options. Furthermore you will also need to supply the SSL certificate and private key to the bot. If you're running the bot with docker, we recommend mounting a volume into the container that contains your SSL certificate and specifying the path accordingly. If you run the bot without docker you can just specify a path on your local filesystem.