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

feat: move helm docs into values files #2281

Merged
merged 4 commits into from
Oct 24, 2023

Conversation

prakrit55
Copy link
Member

fixes: #2196

  • docs comments next to helm values
  • doc.yml files are all deleted
  • generation script is adjusted
  • validate helm pipeline is adjusted and green

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

netlify bot commented Oct 17, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 80f36e1
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/65366c46ee73e700071526a6
😎 Deploy Preview https://deploy-preview-2281--keptn-lifecycle-toolkit.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

could you please put each docs line right above the corresponding helm values?
otherwise, this looks very good already!
if there are @skip statements for a for children of a helm value, please put them above the parent value

@codecov
Copy link

codecov bot commented Oct 17, 2023

Codecov Report

Merging #2281 (47704cc) into main (bffbaf2) will decrease coverage by 26.79%.
The diff coverage is n/a.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2281       +/-   ##
===========================================
- Coverage   85.68%   58.90%   -26.79%     
===========================================
  Files         161       35      -126     
  Lines       10246     2421     -7825     
===========================================
- Hits         8779     1426     -7353     
+ Misses       1192      862      -330     
+ Partials      275      133      -142     

see 141 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 67.43% <ø> (ø)
component-tests 59.38% <ø> (+0.20%) ⬆️
lifecycle-operator ?
metrics-operator ?
scheduler 32.12% <ø> (ø)

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

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

hey @mowies, could you review it once, if we need any more changes over here

@prakrit55
Copy link
Member Author

hey @mowies, should I generate the readme and push it

@mowies
Copy link
Member

mowies commented Oct 23, 2023

@prakrit55 yes! checking the PR now

Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

LGTM, but please push the new generated readme's as well

Signed-off-by: Griffin <prakritimandal611@gmail.com>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 23, 2023
@sonarcloud
Copy link

sonarcloud bot commented Oct 23, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

LGTM! thanks for the contribution!

@odubajDT odubajDT merged commit bd1a37b into keptn:main Oct 24, 2023
41 of 42 checks passed
@prakrit55 prakrit55 deleted the feature/helm-refactor branch November 30, 2023 12:05
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.

Move helm docs into values files
3 participants