docs(changelog): add auto-changelog, npm version hook #891
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. Not having a changelog makes it difficult for developers and open source users to understand the major changes during each release.
Additionally, the use of conventional commit messages are hidden away in the git logs, with some effort required for manual release tagging.
Closes #872
Based off opengovsg/FormSG#306
Solution
Automatically generating and updating a changelog
Use
auto-changelog
to automatically add git log messages to theCHANGELOG.md
during version bump.Release workflow
Develop as usual using conventional messages for each commit message
During release, use
npm version
with-m
flag to add a custom conventional commit message to tag the git version and auto-populate the changelog.For example:
Features:
Improvements:
Deploy Notes
New dev dependencies:
auto-changelog
: For auto-generation and update of CHANGELOG.md