Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update v17 Release notes with a Breaking Change #14215

Merged
merged 1 commit into from
Oct 10, 2023
Merged

Update v17 Release notes with a Breaking Change #14215

merged 1 commit into from
Oct 10, 2023

Conversation

MrFabio
Copy link
Contributor

@MrFabio MrFabio commented Oct 9, 2023 •
edited
Loading

Description

Added a note to the Breaking Changes for the updated version of init_db.sql

Related Issue(s)

#12206

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

None.

@MrFabio MrFabio requested a review from deepthi as a code owner October 9, 2023 16:28
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 9, 2023

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Oct 9, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Oct 9, 2023
@mattlord mattlord removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels Oct 9, 2023
@mattlord mattlord requested a review from frouioui October 9, 2023 16:36
@mattlord mattlord added the Component: Documentation docs related issues/PRs label Oct 9, 2023
mattlord
mattlord approved these changes Oct 9, 2023
View reviewed changes
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks, @MrFabio ! I've made the same change in the GitHub release page: https://github.com/vitessio/vitess/releases/tag/v17.0.0

frouioui
frouioui requested changes Oct 9, 2023
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Hello @MrFabio, thank you for this contribution. Can you also edit the release_notes.md file please?

Note to maintainers: we will need to update the release notes on the UI once this is merged. EDIT: #14215 (review) @mattlord did it.

@MrFabio
Update v17 Release notes Breaking Change
da3c193 
Added a note to the Breaking Changes for the updated version of init_db.sql

Signed-off-by: Fábio Gomes <[email protected]>
@MrFabio
Copy link
Contributor Author

MrFabio commented Oct 9, 2023

Hello @MrFabio, thank you for this contribution. Can you also edit the release_notes.md file please?

Note to maintainers: we will need to update the release notes on the UI once this is merged. EDIT: #14215 (review) @mattlord did it.

Done

@frouioui frouioui self-requested a review October 9, 2023 23:06
frouioui
frouioui approved these changes Oct 9, 2023
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@GuptaManan100 GuptaManan100 merged commit aacb1f5 into vitessio:main Oct 10, 2023
115 checks passed
@MrFabio MrFabio deleted the patch-1 branch October 10, 2023 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@frouioui frouioui frouioui approved these changes

@mattlord mattlord mattlord approved these changes

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

Assignees
No one assigned
Labels
Component: Documentation docs related issues/PRs Type: Release
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@MrFabio @mattlord @frouioui @GuptaManan100