A simple tool for automatically creating merge requests in GitLab
Project description
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.
Usage
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]
- 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
Description in 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 CI
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.
Changelog
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[0.2.7] - 2019-04-13
Changed
Moved changelog back into rst
[0.2.6] - 2019-04-12
Fixed
Removed post1
Changed
Moved changelog to separate file
[0.2.5] - 2019-04-12
Fixed
README badges links
[0.2.4] - 2019-04-12
Fixed
README badges include links
[0.2.3] - 2019-04-12
Added
Tox to the project
readthedocs integration
Changed
README to include readthedocs badge
[0.2.2post1] - 2019-04-11
Added
Updated a README with a Changelog
[0.2.2] - 2019-04-10
Fixed
Formatting error in README
[0.2.1] - 2019-04-10
Fixed
Formatting error in README
[0.2.0] - 2019-04-10
Added
Using black as code formatter
- Added new argument, --use-issue-name which is adds settings from
issue such as labels to the MR.
[0.1.4] - 2019-03-16
Changed
Updated README with new badges and better installation instructions.
[0.1.3] - 2019-03-16
Fixed
Exit with 0 value if MR already exists.
[0.1.2] - 2019-03-16
Fixed
Documentation using gitlab-auto-merge-request instead of gitlab-auto-mr.
[0.1.0] - 2019-03-16
Added
Initial Release.
Appendix
Extra features: Allsimon
Forked from: Tobias L. Maier
Script and idea: Riccardo Padovani
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.