Auto Changelog

How to generate an automatic changelog, for example in a Python package .

Install

Install auto-changelog using npm .

npm install -g auto-changelog

Create a package.json file at the root of your package.

{
  "scripts": {
    "changelog": "auto-changelog -p"
  }
}

Let's now assume you have tagged a new release on Git, you can now run the following command to update the CHANGELOG.md file:

npm run changelog

Since a tag is only bound to a single commit , the changelog won't keep track of the unreleased commits. In order to add those, you can modify package.json :

{
    "scripts": {
        "changelog": "auto-changelog -p --unreleased"
    }
}