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

Add v20 changelog docs for PR #15030 #15367

Merged
merged 2 commits into from
Mar 7, 2024

Conversation

timvaillancourt
Copy link
Contributor

Description

This PR adds a changelog entry to v20 for #15030 now that a changelog subdir exists

Related Issue(s)

#15030

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Feb 26, 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.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required 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 Feb 26, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Feb 26, 2024
@frouioui frouioui 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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Feb 26, 2024
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! Thanks for having kept track of this.

@frouioui frouioui added Type: Documentation Component: Authn/z Authentication / Authorization / Certificates labels Feb 26, 2024
@systay
Copy link
Collaborator

systay commented Feb 27, 2024

@timvaillancourt seems like you missed signing that last commit. Our DCO check is angry.

@frouioui the release notes failing is not very informative. do you if we could we make these checks a bit more verbose if they fail?

Copy link
Member

@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.

Not sure if I got it exactly right but I thought it was worth clarifying.

changelog/20.0/20.0.0/summary.md Outdated Show resolved Hide resolved
@deepthi
Copy link
Member

deepthi commented Feb 27, 2024

oh @timvaillancourt the DCO check is failing. You'll need to amend the commit with a signoff and force-push it.

@deepthi
Copy link
Member

deepthi commented Feb 27, 2024

@frouioui can you look at the static check failure? It's from Check changelog so I'm not sure why it's complaining about go version.

@timvaillancourt
Copy link
Contributor Author

@timvaillancourt seems like you missed signing that last commit. Our DCO check is angry.

@systay oh, fixed now I think (after creating a bit of a mess I force-pushed over 😅)

@frouioui frouioui merged commit 96e0a62 into vitessio:main Mar 7, 2024
100 checks passed
@frouioui
Copy link
Member

frouioui commented Mar 7, 2024

can you look at the static check failure? It's from Check changelog so I'm not sure why it's complaining about go version.

@deepthi done, just had to merge main.

@timvaillancourt timvaillancourt deleted the pr15030-changelog branch June 3, 2024 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Authn/z Authentication / Authorization / Certificates Type: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants