-
Notifications
You must be signed in to change notification settings - Fork 111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Release note / changelog is broken #196
Comments
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: Commit MessagesThe following are example commit messages which conform to the proper format For bug-fixesfix: 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) For new featuresfeat: 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) For breaking changesfeat!: 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) Merging PRsMake sure to merge PRs as a squash and ensure the commit message conforms to the above format ReleaseWhen 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 uses
RELEASE_BODY.md
instead of CHANGELOG.md? Or is it something else?The text was updated successfully, but these errors were encountered: