Skip to content

In changelog version format should be without tag_format #562

Open
@ssiuhk

Description

@ssiuhk

Description

Not sure if I misunderstood, the version format shown on changelog should be $version instead of "TAG_NAME$version"

$ cat .cz.toml | grep tag_format
tag_format = "SOME_TAG_PREFIX_$version"

$ git tag -l
SOME_TAG_PREFIX_1.0.0

Steps to reproduce

  1. Create some commits
  2. Tag them with formatted tags
  3. Bump new version with the option --changelog [or]
  4. Generate changelog with existing tags

Current behavior

For new version

cz bump --dry-run --changelog
bump: version 1.0.0 → 1.1.0
tag to create: SOME_TAG_PREFIX_1.1.0
increment detected: MINOR

## SOME_TAG_PREFIX_1.1.0 (2022-08-20)

### Feat

- **Testing**: Testing something

Generate changelog

$ cz changelog --dry-run
## Unreleased

### Feat

- **Testing**: Testing something

## SOME_TAG_PREFIX_1.0.0 (2022-08-19)

Desired behavior

For new version

$ cz bump --dry-run --changelog
bump: version 1.0.0 → 1.1.0
tag to create: SOME_TAG_PREFIX_1.1.0
increment detected: MINOR

## 1.1.0 (2022-08-20)

### Feat

- **Testing**: Testing something

Generate changelog

$ cz changelog --dry-run
## Unreleased

### Feat

- **Testing**: Testing something

## 1.0.0 (2022-08-19)

Screenshots

No response

Environment

$ cat .cz.toml | grep tag_format
tag_format = "SOME_TAG_PREFIX_$version"

$ git tag -l
SOME_TAG_PREFIX_1.0.0

$ cz version --report
Commitizen Version: 2.31.0
Python Version: 3.6.8 (default, Mar 25 2022, 11:15:52)
[GCC 8.5.0 20210514 (Red Hat 8.5.0-10)]
Operating System: Linux

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions