Clone
4
release note generation
Stephan Bönnemann edited this page 2015-06-12 18:59:04 -07:00

default release notes

The default release notes are a changelog based on the AngularJS Commit Message Conventions.

custom release notes

If you want to generate your own release notes you can provide a generator in the package.json.

Add a release field and provide a path where semantic-release can require it:

"release": {
  "notes": "./lib/custom-release-notes"
}

The module should export a function that calls the provided callback (the last and currently only argument) with an error object or null as the first argument and the release notes(string) as the second argument.

Have a look at the default generator for a sample implementation.