Open j0k3r opened 2 years ago
Changelog is generated based on commit messages, which need to conform to conventional commits
I should have better explained the process to @taoqf - I apologize!
Here is a guide for how to make sure that changelog and releases work properly:
The following are example commit messages which conform to the proper format
fix: Fixed issue with XYZ (fixes #100)
(The fix: prefix means a bug fix has applied, so the patch version will be bumped — ie. 1.0.1 > 1.0.2)
feat: Added feature A
(The feat: prefix means a feature has been added, so the minor version will be bumped — ie. 1.0.1 > 1.1.0)
feat!: Added feature B
(The exclamation mark says it's a breaking change, and the major version will be bumped — ie. 1.0.1 > 2.0.0)
Make sure to merge PRs as a squash and ensure the commit message conforms to the above format
When you're ready to run a release, run
standard-version
This will do the following:
When this is done, quickly make sure that the changelog looks correct, then you can push the commit and tags
After this, the GH action will automatically publish and generate the GH release
Sorry for my mistake.
Since version 5.2.2, no more changelog / release note are generated and it's always the same note attached to each release:
Even the date is locked at
2021-10-28
. Is it because the GitHub Actions usesRELEASE_BODY.md
instead of CHANGELOG.md? Or is it something else?