-
Notifications
You must be signed in to change notification settings - Fork 2k
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 notes generation #7932
Release notes generation #7932
Conversation
Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
8f32120
to
93d1906
Compare
@systay - 93d1906 introduces the rendering of
|
Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
a96cce1
to
2e20f61
Compare
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
d9d67ab
to
15fc3b5
Compare
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Note: we were originally planning on sorting PR information (inside each component) based on their merged date. However, the issue described here cli/cli#3497 occurs. Pull requests are now sorted by their number in increasing order. |
Signed-off-by: Andres Taylor <andres@planetscale.com>
afc0ff7
to
797bfa6
Compare
Signed-off-by: Andres Taylor <andres@planetscale.com>
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.
This is awesome!
For anyone else following along, we will use this to generate an initial release notes which will then be edited by hand (curated) to produce a final version.
|
||
## Checklist | ||
- [ ] Should this PR be backported? |
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.
Do we use the Backport me
label instead?
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.
Correct. The intention is to get rid of these true/false checklists in pull requests, and instead, use them as Todos.
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.
Then let us add that guidance to the PR template 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.
Added that guidance in c1f6d5b.
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.
And I just removed it. @shlomi-noach raised the valid objection that you need write access to the repo to be able to assign labels. I tweaked the text so it's aimed at new contributors without write access, and not aimed at maintainers.
My suggestion is that we maintainers do it for our own PRs and for any PRs we merge.
Alternatively, we could preface the label section with something that this only applies persons with write access to the repo. Not sure which is the better option ¯\_(ツ)_/¯
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
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.
🎉
.github/pull_request_template.md
Outdated
|
||
If your PR needs to be backported, add the label `Backport me!`. | ||
|
||
--> |
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.
Please consider that only people with Write
privileges on our GitHub repo, are able to create labels. Which means the casual contributor is unable to classify their PR by labeling.
I'm not sure if this undermines the purpose of this PR...
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 think it does. We as maintainers should be able to handle labelling before PRs get merged.
And about backporting - deciding what gets backported and what does not has in my experience always been a discussion between maintainers.
Maybe we should just remove this comment altogether from the PR template.
Signed-off-by: Andres Taylor <andres@planetscale.com>
d3bfc68
to
b561119
Compare
Signed-off-by: Andres Taylor <andres@planetscale.com>
b561119
to
aa95ea4
Compare
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.
perhaps add a HTML comment <!-- -->
in the PR template to explain how we should go about labeling? Not sure if it's a great idea, because it's aimed for us the maintainers rather than the contributors. At your discretion.
Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Andres Taylor <andres@planetscale.com>
This PR changes how Vitess creates release-notes for releases.
We'll keep track of which PRs get merged by looking at the git log, and produce the release notes from that.
To group PRs in useful buckets, we'll use labels a bit more than today.
The command looks something like this:
This would generate the release notes for all changes that have gone into the
master
branch sincerelease-10.0
was forked from it.The produced release notes look something like this:
Bug fixes
Query Serving
CI/Build
Cluster management
Other
vttestserver
First PRs are grouped by type, and then by component. If a PR is missing either, "Other" will be used instead.