JoBins

In many projects, creating the changelog is a manual process that is often undesired, error-prone, and time-consuming. This blog describes some tools that can help to automate the changelog creation based on the Git history.

Let’s start with some basics.

Semantic Versioning

Semantic Versioning (SemVer) is a de facto standard for code versioning. It specifies that a version number always contains these three parts:

According to semantic versioning, there are three major parts of a version number:

MAJOR NUMBER: changing it means a breaking change was introduced, usually as a new API incompatible with the previous one;
MINOR NUMBER: changing it means a feature was added to the software, but still being backward compatible;
PATCH NUMBER: changing it means a bug fix or non-relevant change (e.g. refactor) was introduced

Conventional Commits

The Conventional Commits specification proposes introducing a standardized lightweight convention on top of commit messages. This convention dovetails with SemVer, asking software developers to describe in commit messages, features, fixes, and breaking changes that they make.

Developers tend to write commit messages that serve no purpose. Usually, the message does not describe where changes were made, what was changed, and what was the motivation for making the changes.

So I recommend writing commit messages using the Conventional Commits specification:

<type>[optional scope]: <description>

[optional body]

[optional footer]

An example of such a message:

fix: ABC-123: Throwable exception not caught

We did not catch the throwable exception thrown by the API call
and therefore we could not show the error message to the user

The commit type <type> can take one of these values:

fix: Patch of a bug in your codebase and correlates with the patch version in semantic versioning
feat: Introduces a new feature to the codebase and correlates with a minor version in semantic versioning
BREAKING CHANGE: a commit that has the text BREAKING CHANGE: at the beginning of its optional body or footer section introduces a breaking API change and correlates with a major version in semantic versioning. A breaking change can be part of commits of any type. e.g., a fix:, feat: & chore: types would all be valid, in addition to any other type.

Other types like chore:, docs:, style:, refactor:, perf:, test: are recommended by the Angular convention.

Auto Generate Changelog

Now we can start to automate the changelog creation.

Follow the Conventional Commits Specification in your repository. We will use @commitlint/config-conventional to enforce this via Git hooks.
Use standard-version, a utility for versioning using SemVer and changelog generation powered by Conventional Commits.

I will demonstrate the usage based on this demo project which was initialized running npm init.

The next step is to install husky, which sets up your Git hooks:

npx husky-init && npm install

Then install commitlint with a config, which will be used to lint your commit message:

npm install @commitlint/{cli,config-conventional}

As we are using config-conventional we are automatically following the Angular commit convention.

Now we need to tell Husky to run commitlint during the Git commit hook. Therefore, we need to add a commit-msg file to the .husky folder:

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx --no-install commitlint --edit "$1"

Finally, we create a .commitlintrc.json file which extends the rules from config-conventional:

{
  "extends": ["@commitlint/config-conventional"]
}

Running git commit with an invalid message will now cause an error:

▶ git commit -m "this commit message is invalid"
husky > commit-msg (node v14.16.1)
⧗   input: this commit message is invalid
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

husky > commit-msg hook failed (add --no-verify to bypass)

and valid commits will work:

▶ git commit -m "feat: initial feature commit"
[master (root-commit) a87f2ea] feat: initial feature commit
 5 files changed, 1228 insertions(+)
 create mode 100644 .commitlintrc.json
 create mode 100644 .gitignore
 create mode 100644 index.js
 create mode 100644 package-lock.json
 create mode 100644 package.json

Now we are safe and can guarantee that only valid commit messages are in our repository.

Generate Changelog

Finally, we can create our changelog from our Git history. First step is to install standard-version:

npm i --save-dev standard-version

Now we can create some npm scripts in our package.json:

  "scripts": {
    "release": "standard-version",
    "release:minor": "standard-version --release-as minor",
    "release:patch": "standard-version --release-as patch",
    "release:major": "standard-version --release-as major"
  },

The changelog generation can be configured via a .versionrc.json file or placing a standard-version stanza in your package.json.

In our demo we use a .versionrc.json file based on the Conventional Changelog Configuration Spec:

{
    "types": [
      {"type": "feat", "section": "Features"},
      {"type": "fix", "section": "Bug Fixes"},
      {"type": "chore", "hidden": true},
      {"type": "docs", "hidden": true},
      {"type": "style", "hidden": true},
      {"type": "refactor", "hidden": true},
      {"type": "perf", "hidden": true},
      {"type": "test", "hidden": true}
    ],
    "commitUrlFormat": "https://github.com/JoBinsJP/AutomaticChangeLog/commits/{{hash}}",
    "compareUrlFormat": "https://github.com/JoBinsJP/AutomaticChangeLog/compare/{{previousTag}}...{{currentTag}}"
  }

An array of type objects represents the explicitly supported commit message types, and whether they should show up in the generated changelog file. commitUrlFormat is an URL representing a specific commit at a hash and compareUrlFormat is an URL representing the comparison between two git shas.

The first release can be created by running npm run release -- --first-release in the terminal:

▶ npm run release -- --first-release

> changelog-generator-demo@0.0.0 release /Users/user/Sites/AutomaticChangeLog
> standard-version "--first-release"

✖ skip version bump on first release
✔ created CHANGELOG.md
✔ outputting changes to CHANGELOG.md
✔ committing CHANGELOG.md
✔ tagging release v0.0.0
ℹ Run `git push --follow-tags origin master && npm publish` to publish

An exemplary CHANGELOG.md could look similar to this one:

Conclusion

In my opinion, it is worth the effort to introduce the Git commit convention and the changelog generation in our projects. Additionally, we can easily share this with the users of our software so that they also see what they can expect from each new release.