Skip to content

Commit 6dfde4e

Browse files
author
Luca Huettner
committed
docs: Add releaseCount documentation to the readme
1 parent d18af90 commit 6dfde4e

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,27 @@ If you've already run `commit-and-tag-version` when creating your release, you m
343343
the version, by using `commit-and-tag-version --skip.bump`. By default, tagging with an already existing tag make `git` fails.
344344
You can add the `--tag-force` flag to make use of `-f` option when calling `git tag`, then the existing version tag will be replaced.
345345

346+
### Generate changelogs for old releases
347+
348+
Normally only the changelog for the last release will be generated and prepended to the `changelog.md`. If you want to generate changelogs for previous releases you can do so by setting the `releaseCount` option like described [here](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#releasecount).
349+
350+
When setting releaseCount=0 the whole changelog gets regenerated and replaced.
351+
352+
You can set the option either in the`.versionrc` file or inside `package.json` like below
353+
354+
```json
355+
//.versionrc
356+
{
357+
"releaseCount": 0
358+
}
359+
360+
//package.json
361+
362+
"commit-and-tag-version": {
363+
"releaseCount": 0
364+
}
365+
```
366+
346367
### CLI Help
347368

348369
```sh

0 commit comments

Comments
 (0)