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

[Direct PR] [V21 backport] CobraDocs: Remove commit hash from docs. Fix issue with workdir replacement (#17392) #17444

Merged
merged 1 commit into from
Dec 30, 2024

Conversation

rohit-nayak-ps
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps commented Dec 27, 2024

Description

Manual backport of #17392

We need to backport the original PR because we checkout previous releases while generating docs for previous versions and hence the older versions also need the fixes from #17392.

Hoping to piggyback backport these to v19/v20 as well using labels and not have to create manual backports.

Related Issue(s)

#17392

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

@rohit-nayak-ps rohit-nayak-ps added Type: Documentation Type: Enhancement Logical improvement (somewhere between a bug and feature) labels Dec 27, 2024
Copy link
Contributor

vitess-bot bot commented Dec 27, 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 Dec 27, 2024
@rohit-nayak-ps rohit-nayak-ps added Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 and 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 Dec 27, 2024
@github-actions github-actions bot added this to the v21.0.2 milestone Dec 27, 2024
@rohit-nayak-ps rohit-nayak-ps added Component: Documentation docs related issues/PRs and removed Type: Documentation labels Dec 27, 2024
Copy link

codecov bot commented Dec 28, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 67.52%. Comparing base (12df76a) to head (5f96176).
Report is 1 commits behind head on release-21.0.

Files with missing lines Patch % Lines
go/cmd/internal/docgen/docgen.go 75.00% 3 Missing ⚠️
Additional details and impacted files
@@              Coverage Diff              @@
##           release-21.0   #17444   +/-   ##
=============================================
  Coverage         67.51%   67.52%           
=============================================
  Files              1570     1570           
  Lines            251429   251437    +8     
=============================================
+ Hits             169764   169774   +10     
+ Misses            81665    81663    -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dbussink pushed a commit that referenced this pull request Dec 30, 2024
…ix issue with workdir replacement (#17392) (#17444)

Signed-off-by: Rohit Nayak <[email protected]>
Signed-off-by: Dirkjan Bussink <[email protected]>
dbussink pushed a commit that referenced this pull request Dec 30, 2024
…sh from docs. Fix issue with workdir replacement (#17392) (#17444) (#17451)

Signed-off-by: Rohit Nayak <[email protected]>
Signed-off-by: Dirkjan Bussink <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
rohit-nayak-ps added a commit that referenced this pull request Dec 30, 2024
…sh from docs. Fix issue with workdir replacement (#17392) (#17444) (#17450)

Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Rohit Nayak <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 Component: Documentation docs related issues/PRs Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants