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

docs: add cleanPolicy enum values #6064

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

george-e-shaw-iv
Copy link

@george-e-shaw-iv george-e-shaw-iv commented Feb 7, 2025

What problem does this PR solve?

Documentation does not state what the valid values of cleanPolicy is.

What is changed and how does it work?

Added documentation that lists and describes the valid values of cleanPolicy.

Code changes

  • Has Go code change
  • Has CI related scripts change

Tests

  • Unit test
  • E2E test
  • Manual test
  • No code

Side effects

  • Breaking backward compatibility
  • Other side effects:

Related changes

  • Need to cherry-pick to the release branch
  • Need to update the documentation

Release Notes

Please refer to Release Notes Language Style Guide before writing the release note.


* adds `cleanPolicy` enum values to the api reference documentation as
  described in the public website https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-restore-cr
@ti-chi-bot ti-chi-bot bot requested review from howardlau1999 and shonge February 7, 2025 19:24
Copy link
Contributor

ti-chi-bot bot commented Feb 7, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign srstack for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@sre-bot
Copy link
Contributor

sre-bot commented Feb 7, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

ti-chi-bot bot commented Feb 7, 2025

Welcome @george-e-shaw-iv! It looks like this is your first PR to pingcap/tidb-operator 🎉

@ti-chi-bot ti-chi-bot bot added the size/XS label Feb 7, 2025
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.70%. Comparing base (a16b2e8) to head (38dd7d4).
Report is 24 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6064      +/-   ##
==========================================
- Coverage   57.19%   55.70%   -1.50%     
==========================================
  Files         259      266       +7     
  Lines       33233    46185   +12952     
==========================================
+ Hits        19008    25727    +6719     
- Misses      12291    18450    +6159     
- Partials     1934     2008      +74     
Flag Coverage Δ
unittest 55.70% <ø> (-1.50%) ⬇️

@csuzhangxc
Copy link
Member

The api reference documentation is generated from the CRD Golang comments, you need to update the types.go and then run make generate to generate the new api reference documentation.

@george-e-shaw-iv
Copy link
Author

I'm waiting on my company (Atlassian) to approve me signing the CLA and then I'll fix this PR and sign the SLA so it can be merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants