Skip to content

mackee/release-request

Repository files navigation

release-request

The release-request is a cli tool for Pull Request driven deployment.

Description

The release-request is the Pull Request creator on GitHub.

This tool work in like git-flow branch style.

Ex.

  • master: production branch
  • develop: pool features, patches...pending to deployment
  • topic/* and feature/* and etc...: working branches

When you want to deploying to production, You create pull request from develop to master. The release-request is aggregates information of merged working branches and pending branches. You can specify writing that information to description of Pull Request.

Also release-request can write work introductions for deployment to the Pull Request.

Demo

#3 generated by release-request.

Requirement

Install

$ go get -u github.com/mackee/release-request

Usage

Run release-request in directory with-in configration files.

$ release-request

Configuration

release-request is requirement two configuration file that config.yml and release.md. You can rename this files by configuration and cli option.

release-requeste -init generate scaffolding.

$ release-request -init
$ ls
config.yml release.md

You should be set GitHub access token to config.yml.

# in config.yml
token: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

Log

You can set log level by -loglevel=LEVEL. Ex. DEBUG, WARN, ERROR. Default output is WARN and ERROR.

If you set -loglevel=DEBUG, output the command outputs, Pull Request description and titles.

Dry run

-dry-run options is render descriptions and titles but not create/update Pull Request.

Licence

MIT

See also

Author

mackee