Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sue445/gitlab_mr_release

Release MergeRequest generator for GitLab
https://github.com/sue445/gitlab_mr_release

gem gitlab mergerequest release

Last synced: about 1 month ago
JSON representation

Release MergeRequest generator for GitLab

Host: GitHub
URL: https://github.com/sue445/gitlab_mr_release
Owner: sue445
License: mit
Created: 2015-11-12T15:32:53.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-08-02T14:01:53.000Z (5 months ago)
Last Synced: 2024-10-31T15:16:13.114Z (2 months ago)
Topics: gem, gitlab, mergerequest, release
Language: Ruby
Homepage: https://sue445.github.io/gitlab_mr_release/
Size: 212 KB
Stars: 12
Watchers: 5
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # GitlabMrRelease

Release MergeRequest generator for [GitLab](https://about.gitlab.com/)

[![Gem Version](https://badge.fury.io/rb/gitlab_mr_release.svg)](https://badge.fury.io/rb/gitlab_mr_release)

[![Build Status](https://github.com/sue445/gitlab_mr_release/workflows/test/badge.svg?branch=master)](https://github.com/sue445/gitlab_mr_release/actions?query=workflow%3Atest)

[![Code Climate](https://codeclimate.com/github/sue445/gitlab_mr_release/badges/gpa.svg)](https://codeclimate.com/github/sue445/gitlab_mr_release)

[![Coverage Status](https://coveralls.io/repos/sue445/gitlab_mr_release/badge.svg?branch=master&service=github)](https://coveralls.io/github/sue445/gitlab_mr_release?branch=master)

This is inspired by the [git-pr-release](https://github.com/motemen/git-pr-release)

## Requirements

* Ruby v2.1+

* GitLab v8.17.0+

* GitLab API v4+

## Installation

```

$ gem install gitlab_mr_release

```

## Usage

### init

Copy setting files. And edit these files.

```sh

$ gitlab_mr_release init

      create  .env.gitlab

      create  gitlab_mr_release.md.erb

```

see [lib/templates/](lib/templates/)

### create

```sh

$ gitlab_mr_release create --source=develop --target=master --labels=release

MergeRequest is created

[Title] Release develop -> master

[Description]

# MergeRequests

* [ ] !7 Add fresh @sue445

[Url] http://example.com/your/project/merge_requests/15

```

description is accepted MergeRequests title between `--source` and `--target`

![merge_request](img/merge_request.png)

#### detail

```sh

$ gitlab_mr_release help create

Usage:

  gitlab_mr_release create

Options:

  -s, [--source=SOURCE]  # Source branch (e.g. develop)

  -t, [--target=TARGET]  # Target branch (e.g. master)

      [--title=TITLE]    # MergeRequest title (default. 'Release :timestamp :source -> :target')

  -l, [--labels=LABELS]  # Labels for MR as a comma-separated list  (e.g. 'label1,label2')

Create merge requrst

```

#### options

Some options can be specified in both the command arguments and environment variables

* `--source` , `DEFAULT_SOURCE_BRANCH` **(either one is required)**

  * Source branch (e.g. `develop`)

* `--target` , `DEFAULT_TARGET_BRANCH` **(either one is required)**

  * Target branch (e.g. `master`)

* `--title`

  * MergeRequest title (default. 'Release :timestamp :source -> :target')

* `--labels` , `DEFAULT_LABELS`

  * Labels for MR as a comma-separated list (e.g. `label1,label2`, default. no labels)

## ProTip

### .env.gitlab

Environment variables read from `~/.env.gitlab` and current `.env.gitlab`

`~/.env.gitlab` 

```

GITLAB_API_ENDPOINT=http://example.com/api/v4

GITLAB_API_PRIVATE_TOKEN=XXXXXXXXXXXXXXXXXXX

TEMPLATE_FILE=gitlab_mr_release.md.erb

DEFAULT_TITLE=Release <%= Time.now %> <%= source_branch %> -> <%= target_branch %>

```

current `.env.gitlab`

```

GITLAB_PROJECT_NAME=group/name

TEMPLATE_FILE=gitlab_mr_release.md.erb

DEFAULT_SOURCE_BRANCH=develop

DEFAULT_TARGET_BRANCH=master

DEFAULT_LABELS=release

```

If defined both `~/.env.gitlab` and current `.env.gitlab`, current `.env.gitlab` is priority

### variables in template

```markdown

# MergeRequests

<% merge_requests.each do |mr| -%>

* [ ] !<%= mr.iid %> <%= mr.title %> @<%= mr.author.username %>

<% end -%>

```

`merge_requests` is array of [MergeRequest](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/merge_requests.md#get-single-mr)

### variables in DEFAULT_TITLE

```sh

DEFAULT_TITLE=Release <%= Time.now %> <%= source_branch %> -> <%= target_branch %>

```

`DEFAULT_TITLE` supports erb.

* `source_branch` is `--source` or `DEFAULT_SOURCE_BRANCH`

* `target_branch` is `--target` in `DEFAULT_TARGET_BRANCH`

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec gitlab_mr_release` to use the gem in this directory, ignoring other installed copies of this gem.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/gitlab_mr_release.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).