Skip to content

Commit 81b27c5

Browse files
committed
docs(config): add changlog_file a config option
1 parent 2becf57 commit 81b27c5

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/config.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,9 @@ The extra tab before the square brackets (`]`) at the end is required.
6767
| -------- | ---- | ------- | ----------- |
6868
| `name` | `str` | `"cz_conventional_commits"` | Name of the committing rules to use |
6969
| `version` | `str` | `None` | Current version. Example: "0.1.2" |
70-
| `version_files` | `list` | `[ ]` | Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [See more](https://commitizen-tools.github.io/commitizen/bump#files) |
71-
| `tag_format` | `str` | `None` | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more](https://commitizen-tools.github.io/commitizen/bump#tag_format) |
72-
| `bump_message` | `str` | `None` | Create custom commit message, useful to skip ci. [See more](https://commitizen-tools.github.io/commitizen/bump#bump_message) |
70+
| `version_files` | `list` | `[ ]` | Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [See more](https://woile.github.io/commitizen/bump#files) |
71+
| `tag_format` | `str` | `None` | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more](https://woile.github.io/commitizen/bump#tag_format) |
72+
| `bump_message` | `str` | `None` | Create custom commit message, useful to skip ci. [See more](https://woile.github.io/commitizen/bump#bump_message) |
73+
| `changelog_file` | `str` | `CHANGELOG.md` | filename of exported changelog |
7374
| `style` | `list` | see above | Style for the prompts (It will merge this value with default style.) [See More (Styling your prompts with your favorite colors)](https://github.com/tmbo/questionary#additional-features) |
7475
| `customize` | `dict` | `None` | **This is only supported when config through `toml`.** Custom rules for committing and bumping. [See more](https://commitizen-tools.github.io/commitizen/customization/) |

0 commit comments

Comments
 (0)