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

CobraDocs: Remove commit hash from docs. Fix issue with workdir replacement #17392

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

rohit-nayak-ps
Copy link
Contributor

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

Description

  • We remove the commit hash from the generated docs which resulted in unnecessary commits
  • There was a failure in the sed command to replace <WORKDIR> due to incorrect sed invocation. Fixed here.
  • There were files where the WORKDIR sed was not happening. Added

Related Issue(s)

There is a related website PR vitessio/website#1904 which will enhance the current make target to generate the docs to add modified content files to git with an appropriate git message including the current vitess hash.

We need to first merge this PR into main and then run make generated-docs in the website PR before it is ready.

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) Component: Documentation docs related issues/PRs labels Dec 14, 2024
Copy link
Contributor

vitess-bot bot commented Dec 14, 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 14, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Dec 14, 2024
@rohit-nayak-ps rohit-nayak-ps 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 15, 2024
Copy link

codecov bot commented Dec 15, 2024

Codecov Report

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

Project coverage is 67.53%. Comparing base (44aa9d7) to head (5b363ea).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
go/cmd/internal/docgen/docgen.go 75.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17392      +/-   ##
==========================================
+ Coverage   67.47%   67.53%   +0.05%     
==========================================
  Files        1581     1581              
  Lines      253944   253956      +12     
==========================================
+ Hits       171353   171503     +150     
+ Misses      82591    82453     -138     

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

@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review December 15, 2024 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation docs related issues/PRs Type: Documentation Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants