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.

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-18.0] [VTAdmin API] Fix schema cache flag, add documentation (#15704) #15719

Merged
merged 2 commits into from
Apr 15, 2024

Conversation

vitess-bot[bot]
Copy link
Contributor

@vitess-bot vitess-bot bot commented Apr 15, 2024

Description

This is a backport of #15704

Signed-off-by: notfelineit <notfelineit@gmail.com>
@vitess-bot vitess-bot bot added the Backport This is a backport label Apr 15, 2024
@vitess-bot vitess-bot bot requested a review from ajm188 as a code owner April 15, 2024 16:29
@vitess-bot vitess-bot bot added Component: VTAdmin VTadmin interface go labels Apr 15, 2024
@vitess-bot vitess-bot bot requested a review from notfelineit as a code owner April 15, 2024 16:29
@vitess-bot vitess-bot bot added the Type: Bug label Apr 15, 2024
Copy link
Contributor Author

vitess-bot bot commented Apr 15, 2024

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.

@github-actions github-actions bot added this to the v18.0.5 milestone Apr 15, 2024
@notfelineit notfelineit merged commit 9df99ee into release-18.0 Apr 15, 2024
203 checks passed
@notfelineit notfelineit deleted the backport-15704-to-release-18.0 branch April 15, 2024 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport This is a backport Component: VTAdmin VTadmin interface go Type: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants