Skip to content

Commit 6e104ca

Browse files
committed
docs(config): show config sample for version provider
1 parent f87a3af commit 6e104ca

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/config.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,13 @@ Commitizen provides some version providers for some well known formats:
292292
!!! note
293293
The `scm` provider is meant to be used with `setuptools-scm` or any packager `*-scm` plugin.
294294

295+
An example in your `.cz.toml` would look like this:
296+
297+
```toml
298+
[tool.commitizen]
299+
version_provider = "pep621"
300+
```
301+
295302
### Custom version provider
296303

297304
You can add you own version provider by extending `VersionProvider` and exposing it on the `commitizen.provider` entrypoint.

0 commit comments

Comments
 (0)