@@ -442,15 +442,15 @@ Commitizen gives you the possibility to provide your own changelog template, by:
442
442
- as `--template` parameter to both `bump` and `changelog` commands
443
443
- either by providing a template with the same name as the default template
444
444
445
- By default, the template used is the `keep_a_changelog_template .j2` file from the commitizen repository.
445
+ By default, the template used is the `CHANGELOG.md .j2` file from the commitizen repository.
446
446
447
447
# ## Providing a template with your customization class
448
448
449
449
There is 3 parameters available to change the template rendering from your custom `BaseCommitizen`.
450
450
451
451
| Parameter | Type | Default | Description |
452
452
| ----------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------- |
453
- | `template` | `str` | `None` | Provide your own template name (default to `keep_a_changelog_template .j2`) |
453
+ | `template` | `str` | `None` | Provide your own template name (default to `CHANGELOG.md .j2`) |
454
454
| `template_loader` | `str` | `None` | Override the default template loader (so you can provide template from you customization class) |
455
455
| `template_extras` | `dict` | `None` | Provide some extra template parameters |
456
456
@@ -477,7 +477,7 @@ This snippet will:
477
477
478
478
Users can provides their own template from their current working directory (your project root) by :
479
479
480
- - providing a template with the same name (`keep_a_changelog_template .j2` unless overridden by your custom class)
480
+ - providing a template with the same name (`CHANGELOG.md .j2` unless overridden by your custom class)
481
481
- setting your template path as `template` configuration
482
482
- giving your template path as `--template` parameter to `bump` and `changelog` commands
483
483
0 commit comments