GitHub user WangzJi added a comment to the discussion: Proposal: Adopt GitHub 
CI to Auto-Generate Changelogs

Hi @funky-eyes @YongGoose , I’ve created a demo using release-please, which you 
can check out here:
👉 [Demo Repository](https://github.com/WangzJi/release-please-demo)
Here is the generated CHANGELOG.md:
👉 
[CHANGELOG.md](https://github.com/WangzJi/release-please-demo/blob/main/CHANGELOG.md)

While the current setup works, there are still a few things to optimize.

I have a few questions:

If the release notes are generated like in the example above, do we still need 
to maintain the CHANGELOG.md file via release-please, or is it redundant?

What are the best practices for managing both GitHub release notes and the 
CHANGELOG.md? Should we treat the changelog as a historical archive, or rely 
entirely on GitHub Releases?

GitHub link: 
https://github.com/apache/incubator-seata/discussions/7441#discussioncomment-13497084

----
This is an automatically sent email for dev@seata.apache.org.
To unsubscribe, please send an email to: dev-unsubscr...@seata.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@seata.apache.org
For additional commands, e-mail: dev-h...@seata.apache.org

Reply via email to