Reading a markdown file with the progress in the project is easier than reading a commit log.
Automatic changelog generation from commit messages is a fairly common pattern nowadays. There is a project called conventional-changelog that generates a changelog from commit messages that follow a convention.
Commit message convention
The most common convention is the angular commit messages convention which is detailed here.
npm install conventional-changelog -D
- Generate an initial
npx conventional-changelog -p angular -i CHANGELOG.md -s -r 0
- Then keep it updated by adding a
scripttarget to your
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
And now you can add
npm run changelog to your build / push / release process to keep it up to date.