git-cliff VS keep-a-changelog

git-cliff is a terminal tool that can generate changelog from the Git history by using conventional commits, as well as by using regex-powered parsers and you can even change the changelog template itself by using a configuration file. This tool is a great example of text parsing on the terminal and also uses clap_mangen which generates man pages. Useful for anyone who is serious about looking into making a production-ready terminal tool!

Solutions exist for this. Our company does this with git-cliff. Using conventional commits, any commit labeled with the subject "www" will appear in our public changelog.

This was primarily aimed to work with git-cliff to generate changelogs for GitHub releases, since tagging contributors would include them as contributors for the release, while also ensuring structured changelogs thanks to git-cliff. As of now, it requires a few extra steps to get it working with git-cliff, but the integration should be much better once the PR for post-processors is merged.

It's the first time I see someone combining gitmoji with conventional commits (I use the later now for all my project, to generate my changelogs automatically with with git-cliff.)

A style guide for changelogs, adapted from and a stricter subset of [Keep a Changelog](https://keepachangelog.com/)

not entirely related to your question, but worth a read : https://keepachangelog.com/

A Changelog should be written for each release, conforming to the standard https://keepachangelog.com/

I agree, I used to have a NEWS file in my projects (later a NEWS.md), but as others commented, the signification of the term "changelog" has changed. Sites like https://keepachangelog.com/ really refers to release notes or news.

Overall I like the format and advice from https://keepachangelog.com/

We’ve adopted it at work and it’s nice to have a consistent format that is relatively noise free.

You can read more about it at: https://keepachangelog.com/

# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [0.0.4] - 2014-08-09 ### Added - Better explanation of the difference between the file ("CHANGELOG") and its function "the change log". ### Changed - Refer to a "change log" instead of a "CHANGELOG" throughout the site to differentiate between the file and the purpose of the file — the logging of changes. ### Removed - Remove empty sections from CHANGELOG, they occupy too much space and create too much noise in the file. People will have to assume that the missing sections were intentionally left out because they contained no notable changes. ## [0.0.3] - 2014-08-09 ### Added - "Why should I care?" section mentioning The Changelog podcast. ## [0.0.2] - 2014-07-10 ### Added - Explanation of the recommended reverse chronological release ordering. ## [0.0.1] - 2014-05-31 ### Added - This CHANGELOG file to hopefully serve as an evolving example [Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...HEAD [0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4 [0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3 [0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2 [0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1