feat(helm-charts-docs) Automatic readme generation for chart #1209
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
tharun208
force-pushed
the
feat/helm_docs
branch
3 times, most recently
from
7e8d948 to
7608c60
Compare
done by using helm-docs to pull out metadata from values.yml Signed-off-by: Tharun <[email protected]>
tharun208
force-pushed
the
feat/helm_docs
branch
from
7608c60 to
6d3e12d
Compare
|
Please just mark as Draft, no need to put WIP in the title |
nickolaev
changed the title
|
That's super cool! I love the idea. |
nickolaev
reviewed
Nov 25, 2020
austince
reviewed
Nov 25, 2020
mk/dev.mk
Outdated
| @@ -182,6 +183,10 @@ dev/install/goimports: ## Bootstrap: Install goimports | |||
| dev/install/helm3: ## Bootstrap: Install Helm 3 | |||
| curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash | |||
|
|
|||
| .PHONY: dev/install/helm-docs | |||
| dev/install/helm-docs: ## Bootstrap: Install Helm Docs | |||
| go get github.com/norwoodj/helm-docs/cmd/helm-docs | |||
There was a problem hiding this comment.
Is there any way to pin this to a version (even just major)? Maybe we could use the docker image as an alternative if not?
There was a problem hiding this comment.
Actually, there is a binary release available. Let's use that one:
https://github.com/norwoodj/helm-docs/releases
There was a problem hiding this comment.
sure ! will do it
There was a problem hiding this comment.
If we taking binaries, make sure to support Linux and MacOS
There was a problem hiding this comment.
yes, it has support for both
tharun208
force-pushed
the
feat/helm_docs
branch
2 times, most recently
from
c4aa54a to
ace66d7
Compare
Signed-off-by: Tharun <[email protected]>
tharun208
force-pushed
the
feat/helm_docs
branch
from
ace66d7 to
5032288
Compare
…ated readme Signed-off-by: Tharun <[email protected]>
tharun208
force-pushed
the
feat/helm_docs
branch
from
5032288 to
65a93a3
Compare
Signed-off-by: Tharun <[email protected]>
Signed-off-by: Tharun <[email protected]>
Signed-off-by: Tharun <[email protected]>
Signed-off-by: Tharun <[email protected]>
|
@Mergifyio update |
|
Command
|
Signed-off-by: Tharun <[email protected]>
Signed-off-by: Tharun <[email protected]>
|
Will merge this one post 1.0.2 release today. |
1 task
|
@tharun208 will you please fix conflicts |
Signed-off-by: Tharun <[email protected]>
Signed-off-by: Tharun <[email protected]>
austince
approved these changes
Dec 3, 2020
mergify bot
pushed a commit
that referenced
this pull request
Dec 3, 2020
Signed-off-by: Tharun <[email protected]> (cherry picked from commit 56550e0) # Conflicts: # app/kumactl/pkg/install/k8s/control-plane/helmtemplates_vfsdata.go # mk/dev.mk
nickolaev
pushed a commit
that referenced
this pull request
Dec 4, 2020
… (#1274) * feat(kuma-cp) automatic readme generation for chart (#1209) Co-authored-by: Tharun Rajendran <[email protected]> Co-authored-by: Nikolay Nikolaev <[email protected]>
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.
The current readme for the chart is generated manually and doesn't contain all the information available.
Utilize helm-docs to automatically fill out the readme for the helm charts by pulling metadata from values.yml.
values.yml metadata
To allow helm-docs to properly document the values in values.yml a new-style comment is required.
Comment above the value with
# -- metadata to show in readme descriptionwhere the double dashes automaticallyannotates the value.