Skip to content

Rework the generation of the release notes#10510

Merged
systay merged 3 commits intovitessio:mainfrom
planetscale:release-notes-generation
Jun 16, 2022
Merged

Rework the generation of the release notes#10510
systay merged 3 commits intovitessio:mainfrom
planetscale:release-notes-generation

Conversation

@frouioui
Copy link
Copy Markdown
Member

@frouioui frouioui commented Jun 14, 2022

Description

This Pull Request changes how the release notes are generated. They are now divided into two files:

  • A changelog, that lists every Pull Request (regardless of the release notes label).
  • And the actual release notes file that contains the summary, the known issues, and a link to the changelog file.

Reviewers: I have left the 15_0_0_*.md files so you can have a preview, I intend to remove them before merging the Pull Request.

Checklist

  • "Backport me!" label has been added if this change should be backported
  • Tests were added or are not required
  • Documentation was added or is not required

frouioui added 2 commits June 15, 2022 00:16
@frouioui
generate the release changelog as a second document
b2df07a 
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui
include every PR in the release notes
a142b62 
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui frouioui changed the title Rework how the generation of the release notes and the changelog Rework the generation of the release notes Jun 14, 2022
@frouioui frouioui requested a review from deepthi June 14, 2022 22:23
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jun 14, 2022

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has the correct release notes label. release notes none should only be used for PRs that are so trivial that they need not be included.
  • If a new flag is being introduced, review whether it is really needed. The flag names should be clear and intuitive (as far as possible), and the flag's help should be descriptive.
  • If a workflow is added or modified, each items in Jobs should be named in order to mark it as required. If the workflow should be required, the GitHub Admin should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should either include a link to an issue that describes the bug OR an actual description of the bug and how to reproduce, along with a description of the fix.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.

deepthi
deepthi reviewed Jun 15, 2022
View reviewed changes
Copy link
Copy Markdown
Collaborator

@deepthi deepthi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! I love the automation improvements @frouioui

doc/releasenotes/15_0_0_release_notes.md Outdated
@@ -0,0 +1,7 @@
# Release of Vitess v15.0.0
The entire changelog for this release can be found [here](https:/github.com/vitessio/vitess/blob/main/doc/releasenotes/15_0_0_changelog.md).
Copy link
Copy Markdown
Collaborator

@deepthi deepthi Jun 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you create a stub summary file? It can have just something like

## Major Changes

 ### Command-line syntax deprecations

 ### New command line flags and behavior

 ### Online DDL changes

And then the generated release notes should have that at the top, and the link to the changelog after that content.

Copy link
Copy Markdown
Member Author

@frouioui frouioui Jun 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For sure

doc/releasenotes/15_0_0_release_notes.md Outdated
Comment on lines +4 to +7
The release includes 21 commits (excluding merges)

Thanks to all our contributors: @GuptaManan100, @K-Kumar-01, @ajm188, @arvind-murty, @dbussink, @frouioui, @harshit-gangal, @notfelineit, @rohit-nayak-ps, @rsajwani, @shlomi-noach, @systay

Copy link
Copy Markdown
Collaborator

@deepthi deepthi Jun 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We seem to be duplicating this in the release notes and in the changelog. I'd prefer to keep it one place. Maybe the release notes, and remove from changelog.

Copy link
Copy Markdown
Member Author

@frouioui frouioui Jun 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I was unsure about that, sounds good to me!

@frouioui
Moved changelog metrics away from the changelog and added summary for…
124a418 
… v15

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui frouioui requested a review from deepthi June 15, 2022 17:02
deepthi
deepthi reviewed Jun 15, 2022
View reviewed changes
Copy link
Copy Markdown
Collaborator

@deepthi deepthi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
@systay you wanna review?

@systay systay merged commit 04bdce2 into vitessio:main Jun 16, 2022
@systay systay deleted the release-notes-generation branch June 16, 2022 07:36
frouioui added a commit to planetscale/vitess that referenced this pull request Jun 16, 2022
@frouioui
Rework the generation of the release notes (vitessio#10510)
a03c777 
* generate the release changelog as a second document

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* include every PR in the release notes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Moved changelog metrics away from the changelog and added summary for v15

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
frouioui added a commit to planetscale/vitess that referenced this pull request Jun 16, 2022
@frouioui
Rework the generation of the release notes (vitessio#10510)
cda27bc 
* generate the release changelog as a second document

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* include every PR in the release notes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Moved changelog metrics away from the changelog and added summary for v15

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
This was referenced Jun 16, 2022
Merged
Merged
Merged
Merged
frouioui added a commit to planetscale/vitess that referenced this pull request Jun 17, 2022
@frouioui
Rework the generation of the release notes (vitessio#10510)
b58a3fa 
* generate the release changelog as a second document

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* include every PR in the release notes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Moved changelog metrics away from the changelog and added summary for v15

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
frouioui added a commit to planetscale/vitess that referenced this pull request Jun 17, 2022
@frouioui
Rework the generation of the release notes (vitessio#10510)
5539312 
* generate the release changelog as a second document

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* include every PR in the release notes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Moved changelog metrics away from the changelog and added summary for v15

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
frouioui added a commit that referenced this pull request Jun 17, 2022
@frouioui
Rework the generation of the release notes (#10510) (#10531)
f31f446 
* generate the release changelog as a second document

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* include every PR in the release notes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Moved changelog metrics away from the changelog and added summary for v15

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
frouioui added a commit that referenced this pull request Jun 17, 2022
@frouioui
Rework the generation of the release notes (#10510) (#10530)
ccdae30 
* generate the release changelog as a second document

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* include every PR in the release notes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Moved changelog metrics away from the changelog and added summary for v15

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
frouioui added a commit that referenced this pull request Jun 17, 2022
@frouioui
Rework the generation of the release notes (#10510) (#10529)
3ad8ec6 
* generate the release changelog as a second document

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* include every PR in the release notes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Moved changelog metrics away from the changelog and added summary for v15

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
deepthi pushed a commit that referenced this pull request Jun 17, 2022
@frouioui
Rework the generation of the release notes (#10510) (#10532)
b1ab98f 
* generate the release changelog as a second document

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* include every PR in the release notes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Moved changelog metrics away from the changelog and added summary for v15

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@systay systay systay approved these changes

+1 more reviewer

@deepthi deepthi deepthi left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Component: Build/CI Type: CI/Build Type: Release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@frouioui @deepthi @systay