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-15.0] update docgen to embed commit ID in autogenerated doc frontmatter (#14056) #14072

Merged
merged 1 commit into from
Sep 22, 2023

Conversation

vitess-bot[bot]
Copy link
Contributor

@vitess-bot vitess-bot bot commented Sep 22, 2023

Description

This is a backport of #14056

@vitess-bot vitess-bot bot added Backport This is a backport Component: Documentation docs related issues/PRs Merge Conflict Skip CI Skip CI actions from running labels Sep 22, 2023
@vitess-bot
Copy link
Contributor Author

vitess-bot bot commented Sep 22, 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
Copy link
Contributor Author

vitess-bot bot commented Sep 22, 2023

Hello @ajm188, there are conflicts in this backport.

Please address them in order to merge this Pull Request. You can execute the snippet below to reset your branch and resolve the conflict manually.

Make sure you replace origin by the name of the vitessio/vitess remote

git fetch --all
gh pr checkout 14072 -R vitessio/vitess
git reset --hard origin/release-15.0
git cherry-pick -m 1 247cc910b88bc2ac479f7428c1e2197deb903b1b

@vitess-bot vitess-bot bot added the NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work label Sep 22, 2023
@vitess-bot vitess-bot bot requested a review from ajm188 September 22, 2023 01:00
@vitess-bot vitess-bot bot added NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Sep 22, 2023
@vitess-bot vitess-bot bot requested a review from deepthi September 22, 2023 01:00
@github-actions github-actions bot added this to the v15.0.5 milestone Sep 22, 2023
…4056)

Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 ajm188 force-pushed the backport-14056-to-release-15.0 branch from da192b4 to 27db2d4 Compare September 22, 2023 10:13
@ajm188 ajm188 marked this pull request as ready for review September 22, 2023 10:14
@ajm188 ajm188 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says Skip CI Skip CI actions from running NeedsIssue A linked issue is missing for this Pull Request Merge Conflict labels Sep 22, 2023
@ajm188 ajm188 self-assigned this Sep 22, 2023
@ajm188 ajm188 merged commit 328809f into release-15.0 Sep 22, 2023
228 checks passed
@ajm188 ajm188 deleted the backport-14056-to-release-15.0 branch September 22, 2023 22:35
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: Documentation docs related issues/PRs Type: CI/Build
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants