Skip to content
📋 semantic-release plugin to generate changelog content with conventional-changelog
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
lib
test chore(package): update xo to version 0.24.0 Jan 18, 2019
.gitignore
.npmrc
.travis.yml ci: run test on Node.js 10 May 5, 2018
.yarnrc build(npm): Remove package-lock.json/yarn.lock Aug 27, 2017
LICENSE feat: Initial commit 🎉 Aug 15, 2017
README.md
index.js
package.json

README.md

release-notes-generator

semantic-release plugin to generate changelog content with conventional-changelog

Travis Codecov Greenkeeper badge

npm latest version npm next version

Step Description
generateNotes Generate release notes for the commits added since the last release with conventional-changelog.

Install

$ npm install @semantic-release/release-notes-generator -D

Usage

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

{
  "plugins": [
    ["semantic-release/commit-analyzer", {
      "preset": "angular",
      "parserOpts": {
        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
      }
    }],
    ["semantic-release/release-notes-generator", {
      "preset": "angular",
      "parserOpts": {
        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
      },
      "writerOpts": {
        "commitsSort": ["subject", "scope"]
      }
    }]
  ]
}

With this example:

  • the commits that contains BREAKING CHANGE, BREAKING CHANGES or BREAKING in their body will be considered breaking changes (by default the angular preset checks only for BREAKING CHANGE and BREAKING CHANGES)
  • the commits will be sorted in the changelog by subject then scope (by default the angular preset sort the commits in the changelog by scope then subject)

Configuration

Options

Option Description Default
preset conventional-changelog preset (possible values: angular, atom, codemirror, ember, eslint, express, jquery, jshint). angular
config NPM package name of a custom conventional-changelog preset. -
parserOpts Additional conventional-commits-parser options that will extends the ones loaded by preset or config. This is convenient to use a conventional-changelog preset with some customizations without having to create a new module. -
writerOpts Additional conventional-commits-writer options that will extends the ones loaded by preset or config. This is convenient to use a conventional-changelog preset with some customizations without having to create a new module. -

Notes: in order to use a preset it must be installed (for example to use the eslint preset you must install it with npm install conventional-changelog-eslint -D)

Note: config will be overwritten by the values of preset. You should use either preset or config, but not both.

Note: Individual properties of parserOpts and writerOpts will override ones loaded with an explicitly set preset or config. If preset or config are not set, only the properties set in parserOpts and writerOpts will be used.

You can’t perform that action at this time.