Skip to content

Commit 63c529d

Browse files
authored
docs(config/configuration_file.md): document --config option (#1770)
* docs(config/configuration_file.md): document the --config CLI option * docs(config/configuration_file.md): specify the error * docs(config/configuration_file.md): fix indent
1 parent 1d89195 commit 63c529d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/config/configuration_file.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ Configuration files are typically located in the root of your project directory.
2020

2121
The first valid configuration file found will be used. If no configuration file is found, Commitizen will use its default settings.
2222

23+
!!! note
24+
Commitizen supports explicitly specifying a configuration file using the `--config` option, which is useful when the configuration file is not located in the project root directory.
25+
When `--config` is provided, Commitizen will only load configuration from the specified file and will not search for configuration files using the default search order described above. If the specified configuration file does not exist, Commitizen raises the `ConfigFileNotFound` error. If the specified configuration file exists but is empty, Commitizen raises the `ConfigFileIsEmpty` error.
26+
27+
```bash
28+
cz --config <PATH> <command>
29+
```
30+
2331
!!! tip
2432
For Python projects, it's recommended to add your Commitizen configuration to `pyproject.toml` to keep all project configuration in one place.
2533

0 commit comments

Comments
 (0)