Consider using git-cliff to generate CHANGELOG.md

[chatton]

Summary

git-cliff is a tool that generates changelogs using git history and conventional commits.

Proposal

Investigate the viability of incorporating this tool into our development workflow.

The below is sample output from git cliff with all default configuration.

git-cliff --init # create config

vi cliff.toml # update default config to point at cosmos/ibc-go

git-cliff --unreleased # generate markdown

Changelog

All notable changes to this project will be documented in this file.

[unreleased]

Bug Fixes

• Proto-update-deps target on macOS (#1838)
• Ics27 check packet data length explicitly over nil check (#1882)
• Make format and golangci-lint errors (#1894)
• Prevent blocked addresses from sending ICS 20 transfers (#1907)
• Adding check for blocked addresses before escrowing fees (#1890)
• "acknowledgement written" logs unsupported type (#1919)
• Update simd gen accounts cmd to perform same functionality as SDK (#2065)

Documentation

• Add godoc to VerifyMembership regarding path (#1742)
• Readme revamp - support (#2002)

E2E

• Fee middleware counterparty payee not set (#1746)
• Add timeout height helper function (#1982)
• Failed token transfer receiver address is not valid (#1996)
• Add ICA MsgSubmitTx tests (success + failure) (#2021)

Features

• Adding support for backwards compatibility testing (#1912)
• Add channel query client to e2e test suite (#1985)
• Adding test to verify invalid recipient address over incentivized channel (#1970)
• Add successful e2e transfer test (#1973)

Miscellaneous Tasks

• Add backport task for v5.0.x (#1840)
• Delete gitpod.yml (#1841)
• Add task for backport to v6.0.x (#1869)
• Add latest releases and entry for bump of SDK 0.46 (#1872)
• Don't use ioutil (#1920)
• Remove references to AllowUpdateAfterExpiry, AllowUpdateAfterMisbehaviour (#1843)
• Remove AllowUpdateAfterProposal (#1940)
• Adding import for clienttypes (#1990)
• Adding build requirement for e2e (#1993)
• Update fee middleware docs to be more explicit about reasoning for removing invariant checks (#1705)
• Update releases.md and docs website (#1998)
• Moving fee queries to E2ETestSuite (#2030)
• Explicitly set channel version for non-incentivized ica tests (#2036)
• Adding stop relayer func to e2e suite (#2046)
• Set up IBCTestStakingKeeper interface (#2028)
• Adding basic Msg service and RegisterAccount rpc boilerplate (#2068)
• Skip running e2e tests on markdown changes (#2050)

Refactor

• Panic on ZeroCustomFields for solo machine implementation (#1972)
• Remove unnecessary authentication (#1986)
• Remove unused GetHeight fn (#1966)
• Use 4 val nodes for e2e tests (#2016)

Testing

• E2e test for timeout of ics20 packet (#1992)
• Adding interchain accounts test which sends a failed bank transfer (#2049)

Build

• Bump cosmossdk.io/math from 1.0.0-beta.2 to 1.0.0-beta.3 (#1842)
• Bump docker/build-push-action from 3.1.0 to 3.1.1 (#1910)

E2e

• Add 02-client query client (#2005)
• Adding incentivized interchain accounts bank send test (#2023)

---

For Admin Use

• Not duplicate issue
• Appropriate labels applied
• Appropriate contributors tagged/assigned

[damiannolan]

Definitely in favour of exploring an option like this ASAP! There is also a package I've heard about before but never used: https://www.npmjs.com/package/auto-changelog

[colin-axner]

I'd love to have auto generated changelogs asap as well!