Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/x-motemen/git-pr-release
Release pull request generator
https://github.com/x-motemen/git-pr-release
git github pull-requests ruby workflow
Last synced: 4 days ago
JSON representation
Release pull request generator
- Host: GitHub
- URL: https://github.com/x-motemen/git-pr-release
- Owner: x-motemen
- License: mit
- Created: 2013-12-27T06:35:52.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-02-14T13:05:56.000Z (12 months ago)
- Last Synced: 2024-05-01T23:32:04.930Z (10 months ago)
- Topics: git, github, pull-requests, ruby, workflow
- Language: Ruby
- Homepage: https://rubygems.org/gems/git-pr-release
- Size: 179 KB
- Stars: 672
- Watchers: 18
- Forks: 69
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ruby-cli-apps - git-pr-release - Creates a release pull request from production-ready branches. (Awesome Ruby CLIs / Automation)
README
# git-pr-release 
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.
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.
## Usage
`git-pr-release`: default
`git-pr-release --squashed`: include PRs containing squashed commits.
`git-pr-release --overwrite-description`: generate a fresh PR description.
`git-pr-release -n` | `git-pr-release --dry-run`: perform a dry run; does not update PR.
`git-pr-release --no-fetch`: Do not fetch from remote repo before determining target PRs (CI friendly).
`git-pr-release --json`: Show data of target PRs in JSON format.
## 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.
You can specify this value by `GIT_PR_RELEASE_BRANCH_PRODUCTION` environment variable.
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.
You can specify this value by `GIT_PR_RELEASE_BRANCH_STAGING` environment variable.
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.
You can specify this value by `GIT_PR_RELEASE_TEMPLATE` environment variable.
If not specified, the content below is used as the template (embedded in the code):
```erb
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.
You can specify this value by `GIT_PR_RELEASE_LABELS` environment variable.
If not specified, any labels will not be added for PRs.
### `pr-release.mention`
The name that is listed next to each PR title.
Accepted values: `author`
You can specify this value by `GIT_PR_RELEASE_MENTION` environment variable.
If not specified, the mention will be the PR assignee
### `pr-release.ssl-no-verify`
Whether to verify SSL certificate or not.
Accepted values: `true` | `false`
This option might be useful when self-hosted GitHub enterprise server is using self-signed certificate.
You can specify this value by `GIT_PR_RELEASE_SSL_NO_VERIFY` to `1`.
If not specified, verify SSL certificate always.
## Errors and exit statuses
### No pull requests to be released
exit status is 1.
## Author
motemen , original in-house version written by @hitode909.