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 #3137

Closed

Conversation

prakrit55
Copy link
Member

@prakrit55 prakrit55 commented Feb 28, 2024

Description

  • command for the generated manifest for the CRD to helm/chart/templates/
  • command for updating the auto-generated CRD docs by running ./.github/scripts/generate-crd-docs/generate-crd-docs.sh

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)

Copy link

codecov bot commented Feb 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.77%. Comparing base (ce57993) to head (cb5ad69).
Report is 104 commits behind head on main.

❗ Current head cb5ad69 differs from pull request most recent head 223bfd8. Consider uploading reports for the commit 223bfd8 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3137      +/-   ##
==========================================
+ Coverage   85.75%   86.77%   +1.02%     
==========================================
  Files         162      162              
  Lines       10351     8590    -1761     
==========================================
- Hits         8876     7454    -1422     
+ Misses       1186      844     -342     
- Partials      289      292       +3     

see 139 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 69.23% <ø> (+1.80%) ⬆️
component-tests 56.29% <ø> (+0.29%) ⬆️
keptn-lifecycle-operator ?
lifecycle-operator 86.45% <ø> (+1.16%) ⬆️
metrics-operator 88.32% <ø> (+0.68%) ⬆️
scheduler 34.74% <ø> (-1.79%) ⬇️

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

@prakrit55
Copy link
Member Author

@RealAnna, could you check it once

@@ -0,0 +1,13 @@
#!/bin/bash

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of adding a new script in .github I will add them in the respective operators MAKEFILEs

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if possible I would prefer AWK instead of sed since some features of sed are not standardized across platforms

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@github-actions github-actions bot removed the ops label Feb 29, 2024
@prakrit55
Copy link
Member Author

@RealAnna, could u check it once again, made the changes

@RealAnna
Copy link
Contributor

@prakrit55 sorry for the late review, can you please resolve conflicts first so we can run pipeline tests?

@prakrit55 prakrit55 closed this Mar 11, 2024
@prakrit55 prakrit55 force-pushed the chore/command-to-autogenerateHelmandDocs branch from 223bfd8 to 2c3f0b7 Compare March 11, 2024 14:16
Copy link

sonarcloud bot commented Mar 11, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

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
2 participants