70 lines
3.2 KiB
Markdown
70 lines
3.2 KiB
Markdown
# @semantic-release/changelog
|
|
|
|
[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to create or update a changelog file.
|
|
|
|
[](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 first 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"
|
|
]
|
|
}
|
|
```
|