Pull Request Release Bot (pr-release-bot)
A GitHub App built with Probot that creates releases based on PR name patterns and PR tags
Simple and straight forward bot. Built to satisfy my needs and workflow so it's a bit opinionated. If you use gitflow (or something like it) then this bot can be useful.
When you create Pull Request against your releaseTargetBranch, e.g. master, and merge it, this bot will create a release using the body of the pull request as the body of the release.
- The bot will try to deduce the version (semver) of the release from the pull request's name (e.g.
Release v1.0.0). - If the bot is able to get the version from the pull request name, it's good to go.
- Once the pull request is merged, the bot will use the deduced version as the tag, as well as the body of the pull request, to create the GitHub release.
Create a file named .github/pr-release-bot.yml with your configuration:
| Name | Type | Description | Default |
|---|---|---|---|
releaseTargetBranch |
string |
The target branch against which releases are made. | 'master' |
labelsToIgnore |
string[] |
A list of labels which if present on the PR will tell the bot NOT to create a release. | ['pr-release: don't release'] |
releaseName |
string |
The string to use to generate the release name. Use the {version} keyword so pr-release-bot can insert the version. |
'PR Release Bot Release {version}' |
releaseLabel |
string |
A label that pr-release-bot will add to the pull request indicating that it will be released once merged. | 'pr-release: release {version} :shipit:' |
noReleaseLabel |
string |
A label that pr-release-bot will add to the pull request indicating that it will NOT be released once merged. | 'pr-release: won't release' |
Below are a few upcoming features I have in mind for this bot. Feel free to add comments or reactions to the respective issues, or create your own requests.
- List App in Probot's site (need tests first)
- Add the ability to disable comments (#11)
- Add the ability to add a RegEx pattern to determine whether a pull request should be released (#12)
- Add the ability to have different detection strategies (e.g. a branch name, regex pattern against branch names or pull request title, pull request label, etc.)(#13)
- Make the bot smarter by detecting accidental duplicated release versions, or a accidental downgrades (e.g. 1.1.0 -> 1.0.0) (#14)
- Block merging the pull request if it should be released but some information is missing (e.g. version name) (#15)
- Add colors to labels (#8)
- Create a draft of the release when the pull request is created so the user can preview how the release looks
- Add ability to disable the bot all together without un-installing
- Use Pro-Bot's persistence API
- Add support for pre-releases
Although I am planning on doing so (#7), I haven't added any tests to this yet. Use at your own risk.
# Install dependencies
npm install
# Run the bot
npm startIf you have suggestions for how release-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the Contributing Guide.
MIT © 2018 Francisco Calderon [email protected]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent