Released Plugin
This plugin
- comments on the merged PR with the new version
- comments on closed issues with the new version
- adds a
released
label to the pull request - adds a
released
label to closed issues
⚠️ Make sure that you create the
released
label on you project
Installation
This plugin is included with the auto
CLI so you do not have to install it. To install if you are using the auto
API directly:
npm i --save-dev @auto-it/released # or yarn add -D @auto-it/released
npm i --save-dev @auto-it/released # or yarn add -D @auto-it/released
Usage
To use the plugin include it in your .autorc
{ "plugins": ["released"] }
{ "plugins": ["released"] }
Options
Label
Customize the label this plugin attaches to merged pull requests.
{ "plugins": [ [ "released", { "label": ":shipit:" } ] ] }
{ "plugins": [ [ "released", { "label": ":shipit:" } ] ] }
Prerelease Label
Customize the prerelease label this plugin attaches to pull requests merged to prerelease branches.
{ "plugins": [ [ "released", { "prereleaseLabel": "🚧" } ] ] }
{ "plugins": [ [ "released", { "prereleaseLabel": "🚧" } ] ] }
Message
To customize the message this plugin uses on issues and pull requests use the following format.
%TYPE
- EitherPR
orIssue
%VERSION
- The version that was just published
{ "plugins": [ [ "released", { "message": "%TYPE went out with version: %VERSION" } ] ] }
{ "plugins": [ [ "released", { "message": "%TYPE went out with version: %VERSION" } ] ] }
Lock Issue
Lock issues that have been merged in PRs.
{ "plugins": [["released", { "lockIssues": true }]] }
{ "plugins": [["released", { "lockIssues": true }]] }
Include Bot Prs
Whether to comment on PRs made by bots.
{ "plugins": [["released", { "includeBotPrs": true }]] }
{ "plugins": [["released", { "includeBotPrs": true }]] }