Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @semantic-release/changelog with all npm packages installed. Try it out:

require("semantic-release/package.json"); // semantic-release is a peer dependency. var changelog = require("@semantic-release/changelog")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@semantic-release/changelog v5.0.1

semantic-release plugin to create or update a changelog file

@semantic-release/changelog

semantic-release plugin to create or update a changelog file.

Travis Codecov Greenkeeper badge

npm latest version npm next version

StepDescription
verifyConditionsVerify the changelogFile and changelogTitle options configuration.
prepareCreate or update a changelog file in the local project directory with the changelog content created in the generate notes step.

Install

$ npm install @semantic-release/changelog -D

Usage

The plugin can be configured in the semantic-release configuration file:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    ["@semantic-release/changelog", {
      "changelogFile": "docs/CHANGELOG.md",
    }],
    ["@semantic-release/git", {
      "assets": ["docs/CHANGELOG.md"],
    }],
  ]
}

With this example, for each release, a docs/CHANGELOG.md will be created or updated.

Configuration

Options

OptionsDescriptionDefault
changelogFileFile path of the changelog.CHANGELOG.md
changelogTitleTitle of the changelog file (first line of the file).-

Examples

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.

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/changelog",
    "@semantic-release/npm",
    "@semantic-release/git"
  ],
}
RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free