simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: allow to define multiple generateNotes plugins

Browse Source 
Each `generateNotes` plugin will be called in the order defined and will receive the concatenation of the previous one in `nextRelease.notes`.
That gives each plugin the ability to test if there is a notes part that will precede it's own.
Each plugin is expected to return it's own part of the release notes only. **semantic-release** will take care of concatenating all the notes parts.
This commit is contained in:
Pierre Vanduynslager
2018-07-10 13:18:58 -04:00
parent 576eb6027f
commit 5989989452
7 changed files with 96 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/usage/configuration.md
+2 -2
View File
@@ -167,13 +167,13 @@ See [Plugins configuration](plugins.md#configuration) for more details.
### generateNotes
Type: `String`, `Object`
Type: `Array`, `String`, `Object`
Default: `['@semantic-release/release-notes-generator']`
CLI argument: `--generate-notes`
Define the [generate notes plugin](plugins.md#generatenotes-plugin).
Define the [generate notes plugins](plugins.md#generatenotes-plugin).
See [Plugins configuration](plugins.md#configuration) for more details.
docs/usage/plugins.md
+1 -1
View File
@@ -26,7 +26,7 @@ Default implementation: none.
### generateNotes plugin
Responsible for generating release notes.
Responsible for generating release notes. If multiple `generateNotes` plugins are defined, the release notes will be the result of the concatenation of plugin output.
Default implementation: [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator).