sr-release-notes-generator v1.1.3

sr-release-notes-generator

Customizable release-notes-generator plugin for semantic-release based on conventional-changelog

Install

npm install --save-dev semantic-release sr-release-notes-generator

Set the generateNotes plugin for semantic-release in package.json. See semantic-release plugins.

{
  "release": {
    "generateNotes": "sr-release-notes-generator"
  }
}

Options

By default sr-release-notes-generator uses the angular format described in Angular convention.

Additionnal options can be set within the plugin definition in package.json to use a different commit format and to customize it:

{
  "release": {
    "generateNotes": {
      "path": "sr-release-notes-generator",
      "preset": "angular",
      "parserOpts": {
        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
      },
      "writerOpts": {
        "commitsSort": ["subject", "scope"],
      }
    }
  }
}

NOTE: options.config will be overwritten by the values of preset. You should use either preset or config, but not both. Individual properties of parserOpts and writerOpts will overwrite ones loaded with preset or config.

Parser Options

Allow to overwrite specific conventional-commits-parser options. This is convenient to use a conventional-changelog preset with some customizations without having to create a new module.

The following example uses Angular convention but will consider a commit to be a breaking change if it's body contains BREAKING CHANGE, BREAKING CHANGES or BREAKING. By default the preset checks only for BREAKING CHANGE and BREAKING CHANGES.

{
  "release": {
    "generateNotes": {
      "path": "sr-release-notes-generator",
      "preset": "angular",
      "parserOpts": {
        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"],
      }
    }
  }
}

Writer Options

Allow to overwrite specific conventional-commits-writer options. This is convenient to use a conventional-changelog preset with some customizations without having to create a new module.

The following example uses Angular convention but will sort the commits in the changelog by subject then scope. By default the preset sort the commits in the changelog by scope then subject.

{
  "release": {
    "generateNotes": {
      "path": "sr-release-notes-generator",
      "preset": "angular",
      "writerOpts": {
        "commitsSort": ["subject", "scope"],
      }
    }
  }
}