@semantic-release/changelog

Set of semantic-release plugins for creating or updating a changelog file.

verifyConditions

Verify the changelogFile option configuration.

prepare

Create or update the changelog file in the local project repository.

Configuration

Options

Options	Description	Default
changelogFile	File path of the changelog.	CHANGELOG.md

Usage

Options can be set within the plugin definition in the semantic-release configuration file:

{
  "release": {
    "prepare": [
      {
        "path": "@semantic-release/changelog",
        "changelogFile": "docs/changelog.md",
      },
      "@semantic-release/git"
    ]
  }
}

It's recommended to use this plugin with the git plugin, so the changelog file will be committed to the Git repository and available on subsequent builds in order to be updated.

When using with the npm plugin and/or the git plugin the changelog plugin must be called first in order to create or update the changelog file, so it can be included in the npm package and committed to the Git repository.

To use with the npm and git plugins:

{
  "release": {
    "verifyConditions": ["@semantic-release/changelog", "@semantic-release/npm", "@semantic-release/git"],
    "prepare": ["@semantic-release/changelog", "@semantic-release/npm", "@semantic-release/git"]
  }
}