Skip to content

Commit 729dd43

Browse files
committed
feat(config_files): add suport for "cz.toml" config file
1 parent 796a160 commit 729dd43

File tree

5 files changed

+8
-7
lines changed

5 files changed

+8
-7
lines changed

commitizen/defaults.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ class Settings(TypedDict, total=False):
6767
"cz.json",
6868
".cz.yaml",
6969
"cz.yaml",
70+
"cz.toml",
7071
]
7172
encoding: str = "utf-8"
7273

docs/commands/bump.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ regarding if the file is present or not in `version_files`.
408408

409409
Some examples
410410

411-
`pyproject.toml` or `.cz.toml`
411+
`pyproject.toml`, `.cz.toml` or `cz.toml`
412412

413413
```toml
414414
[tool.commitizen]
@@ -441,7 +441,7 @@ defaults to: `bump: version $current_version → $new_version`
441441

442442
Some examples
443443

444-
`pyproject.toml` or `.cz.toml`
444+
`pyproject.toml`, `.cz.toml` or `cz.toml`
445445

446446
```toml
447447
[tool.commitizen]

docs/config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -227,11 +227,11 @@ Provide extra variables to the changelog template. [Read more][template-customiz
227227

228228
## Configuration file
229229

230-
### pyproject.toml or .cz.toml
230+
### pyproject.toml, .cz.toml or cz.toml
231231

232232
Default and recommended configuration format for a project.
233233
For a **python** project, we recommend adding an entry to your `pyproject.toml`.
234-
You can also create a `.cz.toml` file at the root of your project folder.
234+
You can also create a `.cz.toml` or `cz.toml` file at the root of your project folder.
235235

236236
Example configuration:
237237

@@ -339,7 +339,7 @@ Commitizen provides some version providers for some well known formats:
339339
!!! note
340340
The `scm` provider is meant to be used with `setuptools-scm` or any packager `*-scm` plugin.
341341

342-
An example in your `.cz.toml` would look like this:
342+
An example in your `.cz.toml` or `cz.toml` would look like this:
343343

344344
```toml
345345
[tool.commitizen]

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ They differ a bit in design, not sure if cz-js does any of this, but these are s
5757
- create custom rules, version bumps and changelog generation, by default we use the popular conventional commits (I think cz-js allows this).
5858
- single package, install one thing and it will work (cz-js is a monorepo, but you have to install different dependencies AFAIK)
5959
- pre-commit integration
60-
- works on any language project, as long as you create the `.cz.toml` file.
60+
- works on any language project, as long as you create the `.cz.toml` or `cz.toml` file.
6161

6262
Where do they cross paths?
6363

docs/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The assistant utility will help you set up everything
88
cz init
99
```
1010

11-
Alternatively, create a file `.cz.toml` in your project's directory.
11+
Alternatively, create a file `.cz.toml` or `cz.toml` in your project's directory.
1212

1313
```toml
1414
[tool.commitizen]

0 commit comments

Comments
 (0)