chore: auto generate helm docs (#1278)

* chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> * chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> * chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> * chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> * chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> * chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> * chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> * chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> * chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> * chore: auto generate helm docs Signed-off-by: chenk <hen.keinan@gmail.com> --------- Signed-off-by: chenk <hen.keinan@gmail.com>
aquasecurity · Jun 11, 2023 · cb5472e · cb5472e
1 parent dd02f4d
commit cb5472e
Show file tree

Hide file tree

Showing 5 changed files with 291 additions and 325 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -60,6 +60,8 @@ jobs:
         run: go mod vendor
       - name: Verify all generated
         run: make verify-generated
+      - name: Verify Generated Helm docs
+        run: make generate-helm-docs
   tests:
     name: Run tests
     runs-on: ubuntu-latest

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -321,6 +321,15 @@ So if modifying the operator resources, please do so by modifying the Helm
 chart, then run `make manifests` to ensure the static
 resources are up-to-date.
 
+## Update helm docs
+
+We consider the Helm chart to be the master for deploying trivy-operator.
+Since some prefer to not use Helm, we also provide helm config documentation to
+install the operator.
+
+So if modifying the operator helm params, please do so by modifying the Helm
+chart, then run `make generate-helm-docs` to ensure the helm docs are up-to-date.
+
 ## Operator Lifecycle Manager (OLM)
 
 ### Install OLM

diff --git a/Makefile b/Makefile
@@ -125,6 +125,7 @@ $(LOCALBIN):
 
 ## Tool Binaries
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
+HELM_DOCS_GEN ?= $(LOCALBIN)/helm-docs
 ENVTEST ?= $(LOCALBIN)/setup-envtest
 
 ## Tool Versions
@@ -157,6 +158,13 @@ manifests: controller-gen
 .PHONY: generate-all
 generate-all: generate manifests
 
+.PHONY: generate-helm-docs
+generate-helm-docs:
+	GOBIN=$(LOCALBIN) go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
+	$(HELM_DOCS_GEN) ./deploy
+	./hack/verify-generated.sh
+
+
 .PHONY: \
 	clean \
 	docker-build \