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

chore: create command for updating auto-generated docs and helm resources for CRD #3244

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

Conversation

prakrit55
Copy link
Member

Description

  • command for the generated manifest for the CRD to helm/chart/templates/ and helm, crd docs

Fixes #1879

How to test

Please describe how to run the tests that you ran to verify your changes.
Provide instructions so we can reproduce.
Please also provide information about any automatic tests that you added.

  • Manual Test A
  • Unit Test B
  • Integration Test C

Checklist

  • My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
    into multiple PRs)
  • I used descriptive commit messages to help reviewers understand my thought process
  • I signed off all my commits according to the Developer Certificate of Origin (DCO)
    see Contribution Guide
  • My PR title is formatted according to the semantic PR conventions described in
    the Contribution Guide
  • My code follows the style guidelines of this project (golangci-lint passes, YAMLLint passes)
  • I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation (if needed)
  • My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test runs)
  • New and existing unit and integration tests pass locally with my changes

Summary

Please include a short summary of the changes and the related issue.
Please also include relevant motivation and context.
List any dependencies that are required for this change.

Fixes # (issue)

Checks

  • My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
    into multiple PRs)
  • I used descriptive commit messages to help reviewers understand my thought process
  • I signed off all my commits according to the Developer Certificate of Origin (DCO)(
    see Contribution Guide)
  • My PR title is formatted according to the semantic PR conventions described in
    the Contribution Guide
  • My content follows the style guidelines of this project (YAMLLint, markdown-lint)
  • I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
  • I have performed a self-review of my content including grammar and typo errors and also checked the rendered page
    from the Netlify deploy preview
  • My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test runs)

Signed-off-by: Griffin <prakritimandal611@gmail.com>
Copy link

codecov bot commented Mar 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.00%. Comparing base (fffc75b) to head (f1711dc).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3244      +/-   ##
==========================================
- Coverage   87.02%   87.00%   -0.03%     
==========================================
  Files         162      162              
  Lines        8647     8647              
==========================================
- Hits         7525     7523       -2     
- Misses        831      832       +1     
- Partials      291      292       +1     

see 1 file with indirect coverage changes

Flag Coverage Δ
certificate-operator 69.23% <ø> (ø)
component-tests 58.72% <ø> (+0.49%) ⬆️
lifecycle-operator 86.75% <ø> (ø)
metrics-operator 88.32% <ø> (ø)
scheduler 34.74% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Signed-off-by: Griffin <prakritimandal611@gmail.com>
@github-actions github-actions bot added the ops label Mar 14, 2024
prakrit55 and others added 2 commits March 14, 2024 11:58
Signed-off-by: Prakriti Mandal <98270250+prakrit55@users.noreply.github.com>
Signed-off-by: Griffin <prakritimandal611@gmail.com>
@prakrit55 prakrit55 force-pushed the chore/command-to-autogenerateHelmandDocs branch from bbeabcb to ca2209d Compare March 15, 2024 14:10
Signed-off-by: Griffin <prakritimandal611@gmail.com>
Signed-off-by: Griffin <prakritimandal611@gmail.com>
Copy link

sonarcloud bot commented Mar 17, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@prakrit55
Copy link
Member Author

@RealAnna, its ready for review again

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.

Create command for updating auto-generated docs and helm resources for CRD structs
1 participant