-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
[misc] Fix the changelog generator to only count current branch commits #4126
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/taichi-api-docs-preview/taichi/27txJ7f6pRjXdg2HUfyus3u3b91d |
✔️ Deploy Preview for docsite-preview canceled. 🔨 Explore the source changes: f6b13dc 🔍 Inspect the deploy log: https://app.netlify.com/sites/docsite-preview/deploys/61efa481a108670008bfd59a |
if i == 0: | ||
continue |
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.
Not sure why it skips the first tagged commit, but it should be included in the changelog. For example:
change 1 [v0.8.10]
change 2
change 3
change 4 [v0.8.9]
The resulted changelog should be
change 1
change 2
change 3
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.
I guess it was used to skipping version bump commits? @strongoier
but yea it's okay to keep them in the full changelog as well.
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.
If that is the case we can make the parsing more explicit: only keep commits with tags, or other mechanisms to exclude specific commits(PRs) from the changelog.
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.
I don't really remember that because that code was there before I made changes. But it seems that our changelog doesn't miss any commit.
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.
Thanks!!
Related issue = Fix #4118