Skip to content

[feature/changelog] Order Change Types Based on Bump Map Rules #319

Closed
@KyleKing

Description

@KyleKing

Description

The CHANGELOG is ordered with the most recent change type first. This makes the diffs hard to read and may put less important change types over more important ones

Example diff from one of my projects: KyleKing/calcipy@a61d0a4#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4ed

Possible Solution

Could the CHANGELOG be ordered based on the bump rules?

The CHANGELOG could be ordered in descending importance from (MAJOR, MINOR, PATCH, OTHER) where the types within each section would be sorted alphabetically and the OTHER section would capture any change types shown in the CHANGELOG, but not part of the bump rules

Related Issue

I looked through the issues (matching order or changelog) but didn't find any that appear to be asking for the same feature

PR Notes

I would be happy to try to add this functionality, if this feature would be of interest to the maintainers. If not, I may look into separate customization as an alternative to standard functionality)

I created a cz_legacy customization last night, so I have some familiarity with the commitizen code base

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions