Adds generate-helm-docs to makefile

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
thomaspoignant · Apr 10, 2023 · 6fc0e04 · 6fc0e04
1 parent 2c9ce37
commit 6fc0e04
Show file tree

Hide file tree

Showing 5 changed files with 781 additions and 14 deletions.
diff --git a/Makefile b/Makefile
@@ -61,6 +61,10 @@ swagger: ## Build swagger documentation
 	$(GOCMD) install github.com/swaggo/swag/cmd/swag@latest
 	cd cmd/relayproxy && swag init --parseDependency --parseDepth=1 --parseInternal --markdownFiles docs
 
+generate-helm-docs: ## Generates helm documentation for the project
+	$(GOCMD) install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
+	helm-docs
+
 ## Test:
 test: ## Run the tests of the project
 	$(GOTEST) -v -race ./...

diff --git a/cmd/relayproxy/helm-charts/relay-proxy/Chart.yaml b/cmd/relayproxy/helm-charts/relay-proxy/Chart.yaml
@@ -1,6 +1,8 @@
 apiVersion: v2
 name: relay-proxy
 home: https://gofeatureflag.org
+sources:
+  - "https://github.com/thomaspoignant/go-feature-flag"
 description: A Helm chart to deploy go-feature-flag-relay proxy into Kubernetes
 type: application
 version: 1.7.0