From 714d8a12e04f5cbec2e494f21fd823bb01dd08c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20B=C3=B6nnemann?= Date: Fri, 24 Apr 2015 16:02:20 +0200 Subject: [PATCH] Updated release note generation (markdown) --- release-note-generation.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/release-note-generation.md b/release-note-generation.md index 93f023c..ba76edd 100644 --- a/release-note-generation.md +++ b/release-note-generation.md @@ -1 +1,19 @@ -soon.jpg \ No newline at end of file +## default release notes + +The default release notes are a changelog based on the [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit). + +## 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 your it: + +```json +"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](https://github.com/boennemann/semantic-release/blob/master/lib/release-notes.js) for a sample implementation. \ No newline at end of file