#754 Add function to generate the top level READMEs

Weltraumschaf · Weltraumschaf · commit 98f94efe4f69 · 2022-02-16T17:41:43.000+01:00
Signed-off-by: Sven Strittmatter &lt;sven.strittmatter@iteratec.com&gt;
diff --git a/bin/generate-helm-docs.sh b/bin/generate-helm-docs.sh
@@ -10,7 +10,23 @@ COLOR_PREFIX="\e[32m"
 COLOR_ERROR="\e[31m"
 COLOR_RESET="\e[0m"
 
-USAGE="$(basename "${0}") --scanner|--hook|--demo-target|--operator|--auto-discovery path/to/scanner/Chart.yaml path/to/.helm-docs"
+#
+# This script generates various HElm documentation from chart files
+#
+# This script was extracted from the main Makefile to make both easier maintainable.
+#
+# This script provides some switches to generate particular parts of the whole documentation. The documentation
+# Consists of three parts:
+#
+# 1. A main README file for the Chart. This is generated by the switch `--readme`. This is exceptional from the other
+#    switches because it expects thebase directory with all chart files in sub directories. All the readmes for all
+#    charts will be generated in one sigle run.
+# 2. Chart documentation for ArtifactHub. This file is generated as part of this script when invoked with any switch
+#    except the`--readme` switch (see above). Not for all images (see below) a chart documentation wil be generated!
+# 3. Image documentation forDockerHub. . This file is generated as part of this script when invoked with any switch
+#    except the`--readme` switch (see above). Not for all charts (see below) a DockerHub documentation will be generated!
+
+USAGE="$(basename "${0}") --scanner|--hook|--demo-target|--operator|--auto-discovery|--readme path/to/Chart.yaml|dir/with/charts path/to/.helm-docs"
 
 DOC_TYPE="${1:-}"
 CHART_FILE="${2:-}"
@@ -47,19 +63,19 @@ function validate_args() {
 }
 
 function generate_docs() {
-  local chart_search_root output_file docs_template dockerhub_template
+  local chart_search_root output_file docs_template readme_template
 
   chart_search_root="${1}"
   output_file="${2}"
   docs_template="${3}"
-  dockerhub_template="${4}"
+  readme_template="${4}"
 
-  helm-docs --log-level debug \
+  helm-docs \
     --chart-search-root="${chart_search_root}" \
     --output-file="${output_file}" \
     --template-files="${HELM_DOCS_DIR}/templates.gotmpl" \
     --template-files="${docs_template}" \
-    --template-files="${dockerhub_template}"
+    --template-files="${readme_template}"
 }
 
 function generate_scanner_docs() {
@@ -162,19 +178,40 @@ function generate_auto_discovery_docs() {
     "${HELM_DOCS_DIR}/README.ArtifactHub.md.gotmpl"
 }
 
+function generate_readme() {
+  local repo_base_dir
+
+  repo_base_dir="${1}"
+
+  generate_docs "${repo_base_dir}" \
+    "README.md" \
+    ".helm-docs.gotmpl" \
+    "${HELM_DOCS_DIR}/README.md.gotmpl"
+}
+
 function main() {
   validate_args
 
   log "Generating docs for ${CHART_FILE}..."
 
   local work_dir docs_dir
 
-  work_dir="$(dirname "${CHART_FILE}")"
-  docs_dir="${work_dir}/${DOCS_DIR_NAME}"
+  # There are two main cases this script is invoked:
+  # 1. For one found chart file (e.g. of a scanner or hook): In this case we need
+  #    the parent directory of this chart file as working directory and we ned to ensure
+  #    that there is a ${DOCS_DIR_NAME} directory where we store the generated files.
+  # 2. For generating the top level READMEs. Here we expect a base directory as working dir
+  #    from where helm-docs collect all Chart.yml by itself.
+  if [[ -d "${CHART_FILE}" ]]; then
+    work_dir="${CHART_FILE}"
+  else
+    work_dir="$(dirname "${CHART_FILE}")"
+    docs_dir="${work_dir}/${DOCS_DIR_NAME}"
 
-  if [ ! -d "${docs_dir}" ]; then
-    log "Ignoring docs creation process for '${CHART_FILE}' because docs folder found at: '${docs_dir}'!"
-    exit 0
+    if [ ! -d "${docs_dir}" ]; then
+      log "Ignoring docs creation process for '${CHART_FILE}' because docs folder found at: '${docs_dir}'!"
+      exit 0
+    fi
   fi
 
   case "${DOC_TYPE}" in
@@ -193,6 +230,9 @@ function main() {
   "--auto-discovery")
     generate_auto_discovery_docs "${work_dir}"
     ;;
+  "--readme")
+    generate_readme "${work_dir}"
+    ;;
   *)
     error "Unsupported doc type: ${DOC_TYPE}!"
     error "${USAGE}"
