2020 summer update

A long time has passed since we created this program. Our workflow has evolved since and we don't use it any more. Our npm packages live in a monorepo on Github, deployment is via Semaphore CI and commitizen automates all the versioning and changelog updates.

We're saying this because normally we use our programs, following the "eat what you cook" principle of Indieweb opens in a new tab

Purpose

features

7 main features (see above):

  1. Wraps the version with a link (brackets) and creates the diff URL in the footer.
  2. Adds missing diff links in the footer. It's intelligent-enough to detect existing links and their order.
  3. If the .git repo data is successfully read, it will create/convert diff links either in Bitbucket- or GitHub-based repository changelogs.
  4. User account name in diff link is set correctly as per package.json
  5. Project's name in diff link is set correctly as per package.json
  6. "from" version is chosen wisely. If there is no git data available, a previous entry in the changelog will be used. But if there is, the real, previous version will be used. In practice, often there are many patch releases between changelog entries (hence the word used in the title — "notable changes"). If we merely calculated the diff between changelog entries (usually minor/major releases), all patch releases would get caught in between and skew the picture of what was released for real.
  7. If dates are not in ISO format opens in a new tab (year-month-date), we try to convert them. Couple well-known projects with messed-up changelogs are used as guinea pigs in our unit tests.

API - Input

chlu(changelogContents, [gitTags, packageJsonContents])

In other words, it is a string-in, string-out function.

Input argument Type Obligatory? Description
changelogContents String yes Contents of the changelog
gitTags Plain Object no Git data from gitTags opens in a new tab to calculate "from" entry in diff url
packageJsonContents Plain Object no package.json to retrieve the current version

API - Output

It returns a string, processed changelog.

Changelog

See it in the monorepo opens in a new tab, on GitHub.

Contributing

To report bugs or request features or assistance, raise an issue on GitHub opens in a new tab.

Any code contributions welcome! All Pull Requests will be dealt promptly.

Licence

MIT opens in a new tab

Copyright © 2010–2021 Roy Revelt and other contributors

Related packages:

📦 array-group-str-omit-num-char 5.0.1
Groups array of strings by omitting number characters
📦 array-of-arrays-into-ast 3.0.1
Turns an array of arrays of data into a nested tree of plain objects
📦 arrayiffy-if-string 4.0.1
Put non-empty strings into arrays, turn empty-ones into empty arrays. Bypass everything else
📦 array-includes-with-glob 4.0.1
Like _.includes but with wildcards
📦 all-named-html-entities 2.0.1
List of all named HTML entities
📦 array-of-arrays-sort-by-col 4.0.1
Sort array of arrays by column, rippling the sorting outwards from that column
📦 array-pull-all-with-glob 6.0.1
Like _.pullAll but with globs (wildcards)