Adds generate-helm-docs to makefile #681
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Why: to generate helm docs based on values.yaml file How: - using helm-docs binary - adding readme.go.tmpl as a template to generate docs Tags: #helm-docs #makefile #readme #issue-664
✅ Deploy Preview for go-feature-flag-doc-preview canceled.
|
|
Kudos, SonarCloud Quality Gate passed!
|
Codecov Report
@@ Coverage Diff @@
## main #681 +/- ##
=======================================
Coverage 88.44% 88.44%
=======================================
Files 58 58
Lines 2614 2614
=======================================
Hits 2312 2312
Misses 252 252
Partials 50 50 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
thomaspoignant
approved these changes
Apr 12, 2023
There was a problem hiding this comment.
@sarvsav thanks a lot for your help, this is exactly what I was looking for 🙏.
This is super great to have this available.
Thank you for giving me the opportunity to work on this task. :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why: to generate helm docs based on values.yaml file
How:
Tags: #helm-docs #makefile #readme #issue-664
Description
A new command has been added as a part of Makefile to generate the helm documentation.
Changes include
Closes issue(s)
Resolve #664
Checklist
[1] https://github.com/norwoodj/helm-docs