A simple tool for automatically creating merge requests in GitLab
GitLab Auto MR
This is a simple Python script that allows you create MR in GitLab automatically. It is intended to be used in CI/CD as a Docker image. However you can use it as a separate Python library if you would like. An example CI using this can be found here.
It is based on the script and idea of Riccardo Padovani, which he introduced with his blog post How to automatically create new MR on Gitlab with Gitlab CI.
This package was intended to be used by GitLab CI hence using environments provided by the GitLab CI. You can however use it as a CLI tool if you would like.
First you need to create a personal access token, more information here. With the scope api, so it can create the MR using your API.
pip install gitlab-auto-mr gitlab_auto_mr --help Usage: gitlab_auto_mr [OPTIONS]
--private-token TEXT Private GITLAB token, used to authenticate when calling the MR API. [required] --source-branch TEXT The source branch to merge into. [required] --project-id INTEGER The project ID on GitLab to create the MR for. [required] --project-url TEXT The project URL on GitLab to create the MR for. [required] --user-id INTEGER The GitLab user ID to assign the created MR to. [required] --target-branch TEXT The target branch to merge onto. --commit-prefix TEXT Prefix for the MR title i.e. WIP. --remove-branch BOOLEAN Set to True if you want the source branch to be removed after MR. --squash-commits BOOLEAN Set to True if you want commits to be squashed. --description TEXT Path to file to use as the description for the MR. --use-issue-name BOOLEAN If set to True will use information from issue in branch name, must be in the form #issue-number, i.e feature/#6. --help Show this message and exit.
gitlab_auto_mr --private-token $(private_token) --source-branch feature/test --project-id 5 \ --project-url https://gitlab.com/hmajid2301/stegappasaurus --user-id 5
GITLAB_PRIVATE_TOKEN Set a secret variable in your GitLab project with your private token. Name it GITLAB_PRIVATE_TOKEN (CI/CD > Environment Variables). This is necessary to raise the Merge Request on your behalf. More information click here. An example CI using this can be found here.
Add the following to your .gitlab-ci.yml file:
stages: - open open_merge_request: image: registry.gitlab.com/hmajid2301/gitlab-auto-mr before_script:  # We do not need any setup work, let's remove the global one (if any) variables: GIT_STRATEGY: none # We do not need a clone of the GIT repository to create a Merge Request stage: open only: - /^feature\/*/ # We have a very strict naming convention script: - gitlab_auto_mr
You can set extra variables like so.
variables: GIT_STRATEGY: none # We do not need a clone of the GIT repository to create a Merge Request TARGET_BRANCH: master # Target branch for MR
- COMMIT PREFIX: Prefix for the MR i.e. WIP
- REMOVE_BRANCH_AFTER_MERGE: Will delete branch after merge
- SQUASH: Will squash commits after merge
- AUTO_MERGE: Will auto merge request after being reviewed and CI passes
- TARGET_BRANCH: The target branch for the MR
- DESCRIPTION: Description of the MR
- USE_ISSUE_NAME: If set to True will use information from issue in branch name, must be in the form #issue-number, i.e feature/#6.
You can find the changelog here.