Package Exports

github-post-release

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-post-release) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

github-post-release

Post GitHub changelog and close referenced issues after semantic release publishes new module version

Problem

When publishing new version of your NPM package, it would be nice to comment on each GitHub issue referenced by the semantic commits, letting the user know that the fix / feature was published.

This module works as a semantic-release generate notes plugin. It both comments on referenced issues and returns the changelog to be posted on GitHub

It was inspired by semantic-release-github-notifier, release-notes-generator and uses conventional-changelog to generate changelog text after commenting on issues.

Install and use

Requires Node version 6 or above.

npm install --save-dev github-post-release

Then tell semantic-release to use this module as generateNotes plugin.

{
  "release": {
    "generateNotes": "github-post-release"
  }
}

Debug

To see more log messages, run this plugin with DEBUG=github-post-release flag. You can even demo the plugin locally (without actual GitHub updates) using npm run demo.

Small print

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.