Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tmaier/gitlab-auto-merge-request

Tool to automatically open Merge Requests on GitLab (if none exists already)
https://github.com/tmaier/gitlab-auto-merge-request

gitlab gitlab-ci

Last synced: 11 days ago
JSON representation

Tool to automatically open Merge Requests on GitLab (if none exists already)

Host: GitHub
URL: https://github.com/tmaier/gitlab-auto-merge-request
Owner: tmaier
Created: 2017-09-10T08:39:29.000Z (about 7 years ago)
Default Branch: develop
Last Pushed: 2018-10-19T15:45:40.000Z (about 6 years ago)
Last Synced: 2024-10-12T18:15:53.137Z (27 days ago)
Topics: gitlab, gitlab-ci
Language: Shell
Homepage: https://gitlab.com/tmaier/gitlab-auto-merge-request
Size: 19.5 KB
Stars: 73
Watchers: 6
Forks: 25
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        # Open GitLab Merge Requests automatically

[![Docker Automated buil](https://img.shields.io/docker/automated/tmaier/gitlab-auto-merge-request.svg)](https://hub.docker.com/r/tmaier/gitlab-auto-merge-request/)

[![Docker Pulls](https://img.shields.io/docker/pulls/tmaier/gitlab-auto-merge-request.svg)](https://hub.docker.com/r/tmaier/gitlab-auto-merge-request/)

[![Gitlab Project](https://img.shields.io/badge/GitLab-Project-554488.svg)](https://gitlab.com/tmaier/gitlab-auto-merge-request)

This script is meant to be used in GitLab CI to automatically open Merge Requests for feature branches, if there is none yet.

The script is provided as dedicated docker image to improve maintainability in the future.

It is based on the script and idea of [Riccardo Padovani](https://rpadovani.com), which he introduced with his blog post [How to automatically create new MR on Gitlab with Gitlab CI](https://rpadovani.com/open-mr-gitlab-ci).

Thanks for providing this.

## Instructions

### 1) `GITLAB_PRIVATE_TOKEN`

Set a secret variable in your GitLab project with your private token.

Name it `GITLAB_PRIVATE_TOKEN`.

This is necessary to raise the Merge Request on your behalf.

### 2) `.gitlab-ci.yml`

Add the following to your `.gitlab-ci.yml` file:

```yaml

stages:

  - openMr

  - otherStages

Open Merge Request:

  image: tmaier/gitlab-auto-merge-request:1

  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: openMr

  only:

    - /^feature\/*/ # We have a very strict naming convention

  script:

    - merge-request.sh # The name of the script

```

You can see this in action at [`.gitlab-ci.yml` of this project](.gitlab-ci.yml).

## Docker images

The images are hosted on [Docker Hub](https://hub.docker.com/r/tmaier/gitlab-auto-merge-request).

Two tags are noteworthy:

* `latest`: Latest release on `master` branch of this project

* `1`: Latest stable release of `1.x` version (see note on Semantic Versioning below)

## This project is managed on GitLab

The [GitHub project][] is only a mirror of the [GitLab project][].

[GitHub project]: https://github.com/tmaier/gitlab-auto-merge-request

[GitLab project]: https://gitlab.com/tmaier/gitlab-auto-merge-request

Please open Issues and Merge Requests at the [GitLab project][].

## Versioning

This project follows [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

Following are defined as APIs according to the spec:

* How to call this script from `.gitlab-ci.yml`

* Required Environment Variables

Following are not considered as API according to the spec:

* `Dockerfile` and base image used

## Authors

* Docker part: [Tobias L. Maier](http://tobiasmaier.info)

* Script and idea: [Riccardo Padovani](https://rpadovani.com)