#754 Extract auto discovery doc generation as function

Weltraumschaf · Weltraumschaf · commit d1cbcc1eda1a · 2022-02-03T21:24:27.000+01:00
Signed-off-by: Sven Strittmatter &lt;sven.strittmatter@iteratec.com&gt;
diff --git a/Makefile b/Makefile
@@ -77,18 +77,9 @@ scanner-docs: ## Generate documentation for scanners.
 operator-docs: ## Generate documentation for the operator.
 	$(BIN_DIR)/generate-docs.sh --operator $(OPERATOR_DIR)/Chart.yaml $(HELM_DOCS_DIR)
 
-# FIXME: #754 Remove .ONESHELL which is unsupported on some systems
 .PHONY: auto-discovery-docs
-.ONESHELL:
 auto-discovery-docs: ## Generate documentation for the auto-discovery.
-	cd auto-discovery/kubernetes
-	if [ -d "docs" ]; then
-		echo "Docs Folder found at: auto-discovery/kubernetes/docs"
-		helm-docs --template-files=$(HELM_DOCS_DIR)/templates.gotmpl --template-files=.helm-docs.gotmpl --template-files=$(HELM_DOCS_DIR)/README.DockerHub-Core.md.gotmpl --output-file=docs/README.DockerHub-Core.md
-		helm-docs --template-files=$(HELM_DOCS_DIR)/templates.gotmpl --template-files=.helm-docs.gotmpl --template-files=$(HELM_DOCS_DIR)/README.ArtifactHub.md.gotmpl --output-file=docs/README.ArtifactHub.md
-	else
-		echo "Ignoring Docs creation process for Chart $$dir, because no `docs` folder found at: auto-discovery/kubernetes/docs"
-	fi
+	$(BIN_DIR)/generate-docs.sh --operator $(AUTO_DISCOVERY_DIR)/kubernetes/Chart.yaml $(HELM_DOCS_DIR)
 
 .PHONY: demo-target-docs
 demo-target-docs: ## Generate documentation for demo targets.
diff --git a/bin/generate-docs.sh b/bin/generate-docs.sh
@@ -185,8 +185,28 @@ function generate_operator_docs() {
 }
 
 function generate_auto_discovery_docs() {
-  error "Not implemented yet!"
-  exit 1
+  log "Generating auto discovery docs for ${CHART_FILE}..."
+
+  local auto_discovery_dir docs_dir
+
+  auto_discovery_dir="$(dirname "${CHART_FILE}")"
+  docs_dir="${auto_discovery_dir}/docs"
+
+  if [ ! -d "${docs_dir}" ]; then
+    log "Ignoring docs creation process for '${CHART_FILE}' because docs folder found at: '${docs_dir}'!"
+    exit 0
+  fi
+
+  generate_docs "${auto_discovery_dir}" \
+    "docs/README.DockerHub-Core.md" \
+    "${HELM_DOCS_DIR}/templates.gotmpl" \
+    "${auto_discovery_dir}.helm-docs.gotmpl" \
+    "${HELM_DOCS_DIR}/README.DockerHub-Core.md.gotmpl"
+  generate_docs "${auto_discovery_dir}" \
+    "docs/README.ArtifactHub.md" \
+    "${HELM_DOCS_DIR}/templates.gotmpl" \
+    "${auto_discovery_dir}.helm-docs.gotmpl" \
+    "${HELM_DOCS_DIR}/README.ArtifactHub.md.gotmpl"
 }
 
 function main() {
