semantic-release plugin to create or update a changelog file.
||Create or update a changelog file in the local project directory with the changelog content created in the generate notes step.|
$ npm install @semantic-release/changelog -D
The plugin can be configured in the semantic-release configuration file:
With this example, for each release, a
docs/CHANGELOG.md will be created or updated.
||File path of the changelog.||
||Title of the changelog file (first line of the file).||-|
When used with the @semantic-release/git or @semantic-release/npm plugins the
@semantic-release/changelog plugin must be called first in order to update the changelog file so the @semantic-release/git and @semantic-release/npm plugins can include it in the release.