Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/semantic-release/changelog
:blue_book: semantic-release plugin to create or update a changelog file
https://github.com/semantic-release/changelog
changelog conventional-changelog release semantic-release version
Last synced: 3 months ago
JSON representation
:blue_book: semantic-release plugin to create or update a changelog file
- Host: GitHub
- URL: https://github.com/semantic-release/changelog
- Owner: semantic-release
- License: mit
- Created: 2017-12-14T05:29:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T17:11:09.000Z (7 months ago)
- Last Synced: 2024-04-13T19:58:30.810Z (7 months ago)
- Topics: changelog, conventional-changelog, release, semantic-release, version
- Language: JavaScript
- Homepage:
- Size: 2.37 MB
- Stars: 280
- Watchers: 4
- Forks: 25
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - semantic-release/changelog - :blue_book: semantic-release plugin to create or update a changelog file (JavaScript)
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.
[](https://github.com/semantic-release/changelog/actions?query=workflow%3ATest+branch%3Amaster) [](https://www.npmjs.com/package/@semantic-release/changelog)
[](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"
]
}
```