gen-changelog 0.1.1

A very simple script to generate a changelog from a repo with Conventional-Commits-compatible commit messages.

gen_changelog

gen_changelog is a very simple script that generates a changelog from a repository with commit messages compatible with Conventional Commits. The main difference of this script from gitchangelog is that this script will generate sections from dates/months instead of git tags of versions.

Usage

Just run it in the root of your repository:

$ ./gen_changelog "Your project's name"

You're done.

Customization

You can customize the sections you want in the changelog by passing the --categories parameter:

$ ./gen_changelog --categories "add:Added|rem:Removed|chg:Changed|cs:CS:GO stuff"

With pre-commit

To use this with pre-commit, add this to your .pre-commit-config.yaml:

- repo: https://gitlab.com/stavros/gen_changelog.git
  rev: ccc6fa1dbe1a937c9b729e356b5fd91bf9d59ca4
  hooks:
  - id: gen-changelog
    stages: [commit]