@semantic-release/changelog
semantic-release plugin to create or update a changelog file
Last updated 2 days ago by semantic-release-bot .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @semantic-release/changelog 
SYNC missed versions from official npm registry.

@semantic-release/changelog

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

Travis Codecov Greenkeeper badge

npm latest version npm next version

Step Description
verifyConditions Verify the changelogFile and changelogTitle options configuration.
prepare Create 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

Options Description Default
changelogFile File path of the changelog. CHANGELOG.md
changelogTitle Title 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"
  ],
}

Current Tags

  • 5.0.1                                ...           latest (2 days ago)
  • 5.0.0                                ...           next (2 months ago)

21 Versions

  • 5.0.1                                ...           2 days ago
  • 5.0.0                                ...           2 months ago
  • 4.0.0                                ...           3 months ago
  • 3.0.6                                ...           4 months ago
  • 3.0.5                                ...           5 months ago
  • 3.0.4                                ...           10 months ago
  • 3.0.3                                ...           a year ago
  • 3.0.2                                ...           a year ago
  • 3.0.1                                ...           a year ago
  • 3.0.0                                ...           2 years ago
  • 2.1.2                                ...           2 years ago
  • 2.1.1                                ...           2 years ago
  • 2.1.0                                ...           2 years ago
  • 2.0.3                                ...           2 years ago
  • 2.0.2                                ...           2 years ago
  • 2.0.1                                ...           2 years ago
  • 2.0.0                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Downloads
Today 0
This Week 297
This Month 876
Last Day 18
Last Week 184
Last Month 315
Dependencies (4)
Dev Dependencies (8)
Dependents (177)

Copyright 2014 - 2016 © taobao.org |