#754 Extract hook docs generation code into shel script

Weltraumschaf · Weltraumschaf · commit 1aa52653435d · 2022-02-03T17:15:07.000+01:00
Code duplication will be refactored in the next steps.

Signed-off-by: Sven Strittmatter &lt;sven.strittmatter@iteratec.com&gt;
diff --git a/Makefile b/Makefile
@@ -57,29 +57,10 @@ readme:	## Generate README.md based on Chart.yaml and template.
 	@echo ".: ⚙ Generate Helm Docs."
 	helm-docs --template-files=$(HELM_DOCS_DIR)/templates.gotmpl --template-files=.helm-docs.gotmpl --template-files=$(HELM_DOCS_DIR)/README.md.gotmpl
 
-# FIXME: #754 Remove .ONESHELL which is unsupported on some systems
 .PHONY: hook-docs
 hook-docs: ## Generate documentation for hooks.
-	cd hooks; \
-	find . -type f ! -name "$(printf "*\n*")" -name Chart.yaml | while IFS= read -r chart; do \
-	(dir="$$(dirname "$${chart}")"; \
-		echo "Processing Helm Chart in $$dir"; \
-		cd "$${dir}" || exit; \
-		if [ -d "docs" ]; then \
-			echo "Docs Folder found at: $${dir}/docs"; \
-			helm-docs \
-				--template-files="$(HELM_DOCS_DIR)/templates.gotmpl" \
-				--template-files=".helm-docs.gotmpl" \
-				--template-files="$(HELM_DOCS_DIR)/README.DockerHub-Hook.md.gotmpl" \
-				--output-file="docs/README.DockerHub-Hook.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: $${dir}/docs"; \
-		fi) \
+	@for chart in $(HOOKS_CHART_LIST); do \
+		$(BIN_DIR)/generate-docs.sh --hook "$${chart}" $(HELM_DOCS_DIR); \
 	done
 
 .PHONY: scanner-docs
diff --git a/bin/generate-docs.sh b/bin/generate-docs.sh
@@ -10,7 +10,7 @@ COLOR_PREFIX="\e[32m"
 COLOR_ERROR="\e[31m"
 COLOR_RESET="\e[0m"
 
-USAGE="$(basename "${0}") --scanner path/to/scanner/Chart.yaml path/to/.helm-docs"
+USAGE="$(basename "${0}") --scanner|--hook path/to/scanner/Chart.yaml path/to/.helm-docs"
 
 DOC_TYPE="${1:-}"
 CHART_FILE="${2:-}"
@@ -106,11 +106,39 @@ function generate_scanner_docs() {
     "${HELM_DOCS_DIR}/README.ArtifactHub.md.gotmpl"
 }
 
+function generate_hook_docs() {
+  log "Generating hook docs for ${CHART_FILE}..."
+
+  local hook_dir docs_dir
+
+  hook_dir="$(dirname "${CHART_FILE}")"
+  docs_dir="${hook_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 "${hook_dir}" \
+    "docs/README.DockerHub-Hook.md" \
+    "${HELM_DOCS_DIR}/templates.gotmpl" \
+    "${hook_dir}/.helm-docs.gotmpl" \
+    "${HELM_DOCS_DIR}/README.DockerHub-Hook.md.gotmpl"
+  generate_docs "${hook_dir}" \
+    "docs/README.ArtifactHub.md" \
+    "${HELM_DOCS_DIR}/templates.gotmpl" \
+    "${hook_dir}/.helm-docs.gotmpl" \
+    "${HELM_DOCS_DIR}/README.ArtifactHub.md.gotmpl"
+}
+
 function main() {
   case "${DOC_TYPE}" in
   "--scanner")
     generate_scanner_docs
     ;;
+  "--hook")
+    generate_hook_docs
+    ;;
   *)
     error "Unsupported doc type: ${DOC_TYPE}!"
     error "${USAGE}"
