You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The --changelog flag is a great feature for updating CHANGELOG.md during version bumps. However, it currently does not handle nested headings, which makes it incompatible with popular changelog formats like Keep a Changelog.
The new version (0.1.0) is inserted under the nearest heading (### Added) instead of aligning with the heading level of the previous version (##). This disrupts the structure of changelogs that use nested headings for categories (e.g., ### Added, ### Fixed, etc.).
Expected behavior:
The new version should align with the same heading level as the previous version, resulting in:
Instead of inserting the new version under the closest heading, bump should search for the previous version heading at the same level (## in this example) and insert the new version after it. This would make the --changelog flag more compatible with nested heading formats.
The text was updated successfully, but these errors were encountered:
The
--changelog
flag is a great feature for updatingCHANGELOG.md
during version bumps. However, it currently does not handle nested headings, which makes it incompatible with popular changelog formats like Keep a Changelog.For example, given the following changelog:
After running
bump minor --changelog
, the result is:The new version (
0.1.0
) is inserted under the nearest heading (### Added
) instead of aligning with the heading level of the previous version (##
). This disrupts the structure of changelogs that use nested headings for categories (e.g.,### Added
,### Fixed
, etc.).Expected behavior:
The new version should align with the same heading level as the previous version, resulting in:
Proposed solution
Instead of inserting the new version under the closest heading,
bump
should search for the previous version heading at the same level (##
in this example) and insert the new version after it. This would make the--changelog
flag more compatible with nested heading formats.The text was updated successfully, but these errors were encountered: