Installation
Idea
This CLI removes the frivolous changelog file entries generated by commitizen:
Purpose
This application performs the following cleaning steps on all encountered changelog.md
’s:
-
It removes bump-only changelog entries that
conventional-changelog
generates. For example:**Note:** Version bump only for package ...
These will be deleted along with their headings.
-
It removes diff links from headings. Change the following:
## [2.9.1](https://gitlab.com/codsen/codsen/tree/master/packages/ranges-apply/compare/ranges-apply@2.9.0...ranges-apply@2.9.1) (2018-12-27)
into:
## 2.9.1 (2018-12-27)
The diff links are not universal (across Sourcehut, GitLab, GitHub and BitBucket to name few) so it’s more future-proof to remove them.
-
Remove
h1
headings and turn them intoh2
, with the exception of the first, main heading of the changelog.For exampe, change the following:
# [2.0.0](https://gitlab.com/codsen/codsen/tree/master/packages/ranges-apply/compare/ranges-apply@2.0.0...ranges-apply@1.9.1) (2018-12-27)
into:
## 2.0.0 (2018-12-27)
(notice how a second
#
character is added, beside link being removed)