Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 9e9fdb2

Browse files
author
Jan Willhaus
committed
docs(changelog): add config file options changelog_incremental and changelog_start_rev
1 parent 6fba3ab commit 9e9fdb2

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/changelog.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ cz changelog --file-name="CHANGES.md"
114114
115115
### `incremental`
116116
117+
This flag can be set in the `toml` file with the key `changelog_incremental` under `tools.commitizen`
118+
117119
Benefits:
118120
119121
- Build from latest version found in changelog, this is useful if you have a different changelog and want to use commitizen
@@ -124,6 +126,28 @@ Benefits:
124126
cz changelog --incremental
125127
```
126128
129+
```toml
130+
[tools.commitizen]
131+
# ...
132+
changelog_incremental = true
133+
```
134+
135+
### `start-rev`
136+
137+
This value can be set in the `toml` file with the key `changelog_start_rev` under `tools.commitizen`
138+
139+
Start from a given git rev to generate the changelog. Commits before that rev will not be considered. This is especially useful for long-running projects adopting conventional commits, where old commit messages might fail to be parsed for changelog generation.
140+
141+
```bash
142+
cz changelog --start-rev="v0.2.0"
143+
```
144+
145+
```toml
146+
[tools.commitizen]
147+
# ...
148+
changelog_start_rev = "v0.2.0"
149+
```
150+
127151
## Hooks
128152
129153
Supported hook methods:

0 commit comments

Comments
 (0)