Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

git-pr-release Gem Version

Creates a "release pull request", whose body consists of features list or pull requests that are to be released into production. It's especially useful for QA and pre-release checks. git-pr-release automatically collect pull requests merged into master branch and generates the content of the release pull request.

Screenshot

Suitable for branching strategy like below (similar to git-flow):

  • Feature branches are first merged into "staging" (or release, development) branch.
  • Then the staging branch is merged into "production" branch, which is for production release.

Configuration

All configuration are taken using git config. You can write these variables in file .git-pr-release (instead of .git/config or ~/.gitconfig) to share project-wise configuration to other collaborators.

pr-release.token

Token for GitHub API.

If not set, you will be asked to input username/password for one time only, and this configuration variable will be stored.

You can specify this value by GIT_PR_RELEASE_TOKEN environment variable.

pr-release.branch.production

The branch name that is deployed in production environment.

Default value: master.

pr-release.branch.staging

The branch name that the feature branches are merged into and is going to be merged into the "production" branch.

Default value: staging.

pr-release.template

The template file path (relative to the workidir top) for pull requests created. Its first line is used for the PR title, the rest for the body. This is an ERB template.

If not specified, the content below is used as the template (embedded in the code):

Release <%= Time.now %>
<% pull_requests.each do |pr| -%>
<%=  pr.to_checklist_item %>
<% end -%>

pr-release.labels

The labels list for adding to pull requests created. This value should be comma-separated strings.

If not specified, any labels will not be added for PRs.

Errors and exit statuses

No pull requests to be released

exit status is 1.

Failed to create a new pull request

exit status is 2.

Failed to update a pull request

exit status is 3.

Failed to add labels

exit status is 4.

Author

motemen motemen@gmail.com, original in-house version written by @hitode909.