@interaktiv/semantic-release-changelog

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

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.

Table of Contents

• Install
• Usage
• Configuration
  • Options
  • Examples
• Acknowledgment
• License

Install

npm install @interaktiv/semantic-release-changelog --save-dev

Usage

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

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

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 @interaktiv/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",
    "@interaktiv/semantic-release-changelog",
    "@semantic-release/npm",
    "@semantic-release/git"
  ]
}

Acknowledgment

Big thanks for the semantic-release team for the original @semantic-release/changelog plugin. This is a fork of it with slightly adjustments (mainly change log title handling) that suit our needs.

License

MIT Copyright © 2019-present die.interaktiven GmbH & Co. KG