-
-
Notifications
You must be signed in to change notification settings - Fork 6.3k
feat: automatic generation of release notes #35977
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
base: main
Are you sure you want to change the base?
feat: automatic generation of release notes #35977
Conversation
d36f97f to
f32b963
Compare
|
Also cc @techknowlogick for further review and help (#35976 (comment)) , in case you already have more discussions. |
|
In 1406ccc:
|
|
In followup PR, when I find some time I will implement additional configuration for this feature, like it is on GitHub: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes |
Still many And #35977 (comment)
|
Ok, I made it less defensive now @wxiaoguang
We haven't, but @techknowlogick feel free to review my PR |
wxiaoguang
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH, still questions (only a quick look, not carefully look into backend code yet)
@lunny It only works for pull requests. Did you have them, or just commits? It mimics the Github behavior. |
Okay, I see. I assume it currently collects commits. In the future, we could consider adding an option to collect either commits or pull requests. |
It's practically useless to me when it does not include commits without a associated pull request, as I think that's a very common scenario, for example when the repo owner does fixups etc. But if it matches GH (it seems so), I won't block on it. |
|
A UX problem: If user has input many message in the textarea, then click the "Generate release notes" button, then their work is lost and no way to undo? Is it better to "append" but not "replace"? |
I can implement that in the following PR, along with other improvements. But first, I'd like to have this one merged. |
Fine with me. |
|
Branch needs to be updated and it will likely have some new typescript issues because we enabled |
|
Will make some changes to address these concerns and fix more UI problems. |
|
Now a new question: func findInitialCommit(commit *git.Commit) (*git.Commit, error) {
// FIXME: this method is inefficient for large repos with long histories, and it doesn't seem right:
// FIXME: "git diff aaaa...bbbb" doesn't include commits from "aaaa", so the changes in "root commit" won't appear in the tag release's diff.
// No idea whether we should really make things so complicated. |



Add GitHub-style automatic release notes generation
Screenshots