Skip to content
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

Open
j0k3r opened this issue Mar 14, 2022 · 2 comments
Open

Release note / changelog is broken #196

j0k3r opened this issue Mar 14, 2022 · 2 comments

Comments

@j0k3r
Copy link

j0k3r commented Mar 14, 2022

Since version 5.2.2, no more changelog / release note are generated and it's always the same note attached to each release:

image

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?

@nonara
Copy link
Collaborator

nonara commented Mar 16, 2022

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 Messages

The following are example commit messages which conform to the proper format

For bug-fixes

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)

For new features

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)

For breaking changes

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)

Merging PRs

Make sure to merge PRs as a squash and ensure the commit message conforms to the above format

Release

When you're ready to run a release, run

standard-version

This will do the following:

  • Update changelog
  • Bump the version #
  • Create a commit with the version #
  • Create a tag with the version # on the new commit

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

@taoqf
Copy link
Owner

taoqf commented Mar 26, 2022

Sorry for my mistake.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants