# @semantic-release/changelog > semantic-release plugin to create or update a changelog file Latest version **7.0.0** (published 2026-07-21) · MIT license · 0 weekly downloads ## Install ```sh npm install @semantic-release/changelog pnpm add @semantic-release/changelog yarn add @semantic-release/changelog bun add @semantic-release/changelog ``` ## Health **Score 65/100 (B)** — status: active. Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score. Warnings: low downloads; no types. ## Facts | | | |---|---| | Version | 7.0.0 | | Published | 2026-07-21 | | First published | 2017-12-17 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM | | Node | ^22.22.2 \|\| >=24.15 | | Dependencies | 3 | | Unpacked size | 11.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 338 | | Author | Pierre Vanduynslager | | Maintainers | semantic-release-bot, gr2m, travi | | Keywords | changelog, conventional-changelog, release, semantic-release, version | ## Links - npm: https://www.npmjs.com/package/@semantic-release/changelog - Repository: https://github.com/semantic-release/changelog - Homepage: https://github.com/semantic-release/changelog#readme - Issues: https://github.com/semantic-release/changelog/issues - npm.io page: https://npm.io/package/@semantic-release/changelog ## Dependencies (3) - [lodash-es](https://npm.io/package/lodash-es.md) ^4.17.21 - [aggregate-error](https://npm.io/package/aggregate-error.md) ^5.0.0 - [@semantic-release/error](https://npm.io/package/@semantic-release/error.md) ^4.0.0 ## Alternatives - [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads - [log](https://npm.io/package/log.md) — 1.3M weekly downloads - [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads - [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads - [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads ## Recent versions - 7.0.0 (latest) — 2026-07-21 - 7.0.0-beta.1 (beta) — 2026-04-23 - 5.0.0 (next) — 2020-01-27 - 6.0.3 — 2023-03-23 - 6.0.2 — 2022-11-29 - 6.0.1 — 2021-10-30 - 6.0.0 — 2021-09-22 - 5.0.1 — 2020-03-27 - 4.0.0 — 2020-01-09 - 3.0.6 — 2019-11-21 - 3.0.5 — 2019-10-26 - 3.0.4 — 2019-05-14 - 3.0.3 — 2019-04-14 - 3.0.2 — 2018-12-26 - 3.0.1 — 2018-10-08 - … 12 more at https://npm.io/package/@semantic-release/changelog/versions ## README # @semantic-release/changelog [**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to create or update a changelog file. > [!WARNING] > Please consider whether committing release notes to a file is worth the [added complexity](https://semantic-release.gitbook.io/semantic-release/support/faq#should-release-notes-be-committed-to-a-changelog.md-in-my-repository-during-a-release) compared to other available options for capturing release notes. [![Build Status](https://github.com/semantic-release/changelog/workflows/Test/badge.svg)](https://github.com/semantic-release/changelog/actions?query=workflow%3ATest+branch%3Amaster) [![npm latest version](https://img.shields.io/npm/v/@semantic-release/changelog/latest.svg)](https://www.npmjs.com/package/@semantic-release/changelog) [![npm next version](https://img.shields.io/npm/v/@semantic-release/changelog/next.svg)](https://www.npmjs.com/package/@semantic-release/changelog) | 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](https://github.com/semantic-release/semantic-release#release-steps). | ## Install ```bash $ npm install @semantic-release/changelog -D ``` ## Usage The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration): ```json { "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](https://github.com/semantic-release/git) or [@semantic-release/npm](https://github.com/semantic-release/npm) plugins the `@semantic-release/changelog` plugin must be called before those plugins in order to update the changelog file so the [@semantic-release/git](https://github.com/semantic-release/git) and [@semantic-release/npm](https://github.com/semantic-release/npm) plugins can include it in the release. ```json { "plugins": [ "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", "@semantic-release/changelog", "@semantic-release/npm", "@semantic-release/git" ] } ``` --- _Source: https://npm.io/package/@semantic-release/changelog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._