6.0.3 • Published 2 years ago

@semantic-release/changelog v6.0.3

Weekly downloads
187,475
License
MIT
Repository
github
Last release
2 years ago

@semantic-release/changelog

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

Build Status 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"
  ]
}
@tractorzoom/semantic-release-configdocuments-service-apipromo-design-system@html-validate/semantic-releasesemantic-release-trustflight-config@lansweeper/semantic-release-config@droplt/core@openpatch/semantic-releasevm-patternlibrary@test-babu-library/aifian-babu@test-aifian-library/aifian_storybook_babu@coobeet/semantic-release-configtest-semantic-release-yakovlevyuri-2@wishlez/semantic-release@araclx/semantic-release@vodyani/semantic-release@amag-ch/sap_pipeline_semantic_release_configuration_npm@infinitebrahmanuniverse/nolb-_sema@adfinis-sygroup/semantic-release-configcitymapjob-web-appdh-test-cafe-automation-library@everything-registry/sub-chunk-818@peakfijn/config-release-expo@peakfijn/config-release-laravel@peakfijn/expo-semantic-release@do-killer/convert-to-excel-extensions@healform/liquidt1t4n-releasetest-library-huygurwp-releasetelar-coretelar-mvcstarwars-names-kshzhspire-plugin-semantic-releasetest-release-actionvalues-coverageverdaccio-redis-search-patchverdaccio-install-counts@divlook/semantic-release-config@djdmbrwsk/common-semantic-release@dodoex/widgets@droplt/semantic-release-config@code-quality/test-c@code-quality/semantic-release-config@codedependant/release-config-core@crazejs/lint@crystal-ball/semantic-release-base@comperio/query-builder@conexia-learning/events-handler@conexia-lex/lex-components@dan-nz/semantic-release-config@colonise/config@commercelayer/react-utils@cycjimmy/semantic-release-action@dinhoabreu/semantic-release-bitbucket-config@darkobits/semantic-release-config@developer_impetus/typegen1@deepwizards/bengine-cli@deopea.os/semantic-release-config@demartini/semantic-release-config@douglasneuroinformatics/semantic-release@calebboyd/semantic-release-config@call-a3/semantic-release@bluebase/code-standards@peakfijn/config-release@peakfijn/config-release-reactj-stalk_frontjenkinesist-user-experiencejava-projectkahana-libkuzzle-plugin-s3@ng-easy/builders@theholocron/semantic-release-config@joshunrau/semantic-release-config@sisgea/nest-authz-connectvelquinest-trace-loggingss-logging-toolspw-perxtech-api-clienttypescript-project-bootstraptest-auto-package-releasetmdbrjstonfura-sdk@anycli/semantic-release@arbetsmyra/semantic-release-config@approvals-cloud/shared@anders1101/semantic-release-configuration@anolilab/semantic-release-preset@anny_aifian/test_babu_library@atir-naveed-geeksltd/semantic-release-config@atom-ide-community/semantic-release-npm-config@audi2014/npmjs-test@alanscodelog/semantic-release-config@akijoey/semantic-release-config@batch/git-tools@bauglir/semantic-release-configuration@beecode/msh-config@bjoluc/semantic-release-config-npm
6.0.3

2 years ago

6.0.2

2 years ago

6.0.1

4 years ago

6.0.0

4 years ago

5.0.1

5 years ago

5.0.0

5 years ago

4.0.0

5 years ago

3.0.6

5 years ago

3.0.5

6 years ago

3.0.4

6 years ago

3.0.3

6 years ago

3.0.2

6 years ago

3.0.1

7 years ago

3.0.0

7 years ago

2.1.2

7 years ago

2.1.1

7 years ago

2.1.0

7 years ago

2.0.3

7 years ago

2.0.2

7 years ago

2.0.1

7 years ago

2.0.0

7 years ago

1.1.1

7 years ago

1.1.0

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago