lerna-clean-changelogs-cli^1.3.1

CLI application to cleanse the lerna/commitizen-generated changelogs

Install globally, via npm

This is a CLI app so you install it globally, with -g:

npm i -g lerna-clean-changelogs-cli

Then, call it from the command line using one of the following keywords:

lcc
lernacleanchangelog

Alternatively, CLI's can also be installed as local dependencies, but you then have to call them through package.json, through npm script.

Trivia

This program has 10 assertions in its unit tests. That's less than all unit test assertions' median (50) and less than geometric mean (70).

§ Use it

Once installed, call it one of two ways:

$ lcc
$ lernacleanchangelog

PS. That dollar sign above just means it's a terminal. Never type that dollar sign!

§ 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 ranges-apply
```
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/[email protected]@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 into h2, 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/[email protected]@1.9.1) (2018-12-27)
```
into:
```
## 2.0.0 (2018-12-27)
```
(notice how a second # character is added, beside link being removed)

⬆ back to top

§ The proof of the pudding is in the eating

Here's how we use it ourselves.

In short, sourcehut CI calls package.json script and it cleanses the changelogs before npm package is published to npm and all builds are comitted from CI to git.

Have a look at our sourcehut CI yml :

{ { ciConfig | safe } }

There's a line:

- npm run pub:vers

That's how CI calls npm script. By the way, "lerna-clean-changelogs-cli" can be called at all because our monorepo root package.json has it as a dev-dependency:

"devDependencies": {
  ...
  "lerna-clean-changelogs-cli": "^1.3.1",
  ...
}

In the package.json, pub:vers looks like this:

"pub:vers": "lerna version --conventional-commits --no-commit-hooks --yes && lernacleanchangelog '**'",

We call lerna version and then we call lernacleanchangelog — the call name for lerna-clean-changelogs-cli. We could also call lcc instead but it's more descriptive, considering you come back after months and wonder what is such and such command...

⬆ back to top