Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 241faad

Browse files
noirbizarreLee-W
authored andcommitted
style(CHANGELOG.md): rename the default template as CHANGELOG.md.j2
1 parent 3adc171 commit 241faad

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

‎commitizen/changelog.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
if TYPE_CHECKING:
5757
from commitizen.version_schemes import VersionScheme
5858

59-
DEFAULT_TEMPLATE = "keep_a_changelog_template.j2"
59+
DEFAULT_TEMPLATE = "CHANGELOG.md.j2"
6060

6161

6262
def get_commit_tag(commit: GitCommit, tags: list[GitTag]) -> GitTag | None:
File renamed without changes.

‎docs/customization.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -442,15 +442,15 @@ Commitizen gives you the possibility to provide your own changelog template, by:
442442
- as `--template` parameter to both `bump` and `changelog` commands
443443
- either by providing a template with the same name as the default template
444444

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.
446446

447447
### Providing a template with your customization class
448448

449449
There is 3 parameters available to change the template rendering from your custom `BaseCommitizen`.
450450

451451
| Parameter | Type | Default | Description |
452452
| ----------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------- |
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`) |
454454
| `template_loader` | `str` | `None` | Override the default template loader (so you can provide template from you customization class) |
455455
| `template_extras` | `dict` | `None` | Provide some extra template parameters |
456456

@@ -477,7 +477,7 @@ This snippet will:
477477

478478
Users can provides their own template from their current working directory (your project root) by:
479479

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)
481481
- setting your template path as `template` configuration
482482
- giving your template path as `--template` parameter to `bump` and `changelog` commands
483483

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /