Bugfix: Docs - module and actions rendering (#614)

* add logging * more debugging * https://arc.net/l/quote/pplohupq * copy from .github * further debugging * Revert "copy from .github" This reverts commit 7df0b98. * use python 3.12 * try something * try something * fix actions * cleanup * troubleshooting * remove gomplate version * remove foo * rename * add / * add / * add / * cleanup
cloudposse · Jun 25, 2024 · 54b349f · 54b349f
1 parent 50c5558
commit 54b349f
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/scripts/docs-collator/GitHubActionRenderer.py b/scripts/docs-collator/GitHubActionRenderer.py
@@ -56,7 +56,7 @@ def __render_readme(self, module_download_dir, module_docs_dir):
                                    f"README_FILE={readme_md_file}",
                                    f"README_YAML={readme_yaml_file}",
                                    f"README_TEMPLATE_YAML={readme_yaml_file}",
-                                   f"README_INCLUDES={module_download_dir}"], capture_output=True)
+                                   f"README_INCLUDES={module_download_dir}/"], capture_output=True)
 
         if response.returncode != 0:
             error_message = response.stderr.decode("utf-8")

diff --git a/scripts/docs-collator/ModuleRenderer.py b/scripts/docs-collator/ModuleRenderer.py
@@ -60,12 +60,13 @@ def __render_readme(self, module_download_dir, module_docs_dir):
 
         io.create_dirs(module_docs_dir)
 
+        logging.info(f"Running `make readme README_TEMPLATE_FILE={readme_tmpl_file} README_FILE={readme_md_file} README_YAML={readme_yaml_file} README_TEMPLATE_YAML={readme_yaml_file} README_INCLUDES={module_download_dir}`")
         response = subprocess.run(["make", "readme",
                                    f"README_TEMPLATE_FILE={readme_tmpl_file}",
                                    f"README_FILE={readme_md_file}",
                                    f"README_YAML={readme_yaml_file}",
                                    f"README_TEMPLATE_YAML={readme_yaml_file}",
-                                   f"README_INCLUDES={module_download_dir}"], capture_output=True)
+                                   f"README_INCLUDES={module_download_dir}/"], capture_output=True)
 
         if response.returncode != 0:
             error_message = response.stderr.decode("utf-8")

diff --git a/scripts/docs-collator/templates/github-actions/readme.md b/scripts/docs-collator/templates/github-actions/readme.md
@@ -1,5 +1,5 @@
-{{- defineDatasource "config" .Env.README_YAML | regexp.Replace ".*" "" -}}
-{{- defineDatasource "includes" .Env.README_INCLUDES | regexp.Replace ".*" "" -}}
+{{- defineDatasource "config" .Env.README_YAML -}}
+{{- defineDatasource "includes" (env.Getenv "README_INCLUDES") -}}
 {{- $deprecated := has (ds "config") "deprecated" -}}
 {{- $fullName := (ds "config").name -}}
 {{- $shortName := (index ($fullName | strings.SplitN "-" 3) 2) -}}

diff --git a/scripts/docs-collator/templates/modules/readme.md b/scripts/docs-collator/templates/modules/readme.md
@@ -1,5 +1,5 @@
-{{- defineDatasource "config" .Env.README_YAML | regexp.Replace ".*" "" -}}
-{{- defineDatasource "includes" .Env.README_INCLUDES | regexp.Replace ".*" "" -}}
+{{- defineDatasource "config" .Env.README_YAML -}}
+{{- defineDatasource "readmeIncludesDir" .Env.README_INCLUDES -}}
 {{- $deprecated := has (ds "config") "deprecated" -}}
 {{- $fullModuleName := (ds "config").name -}}
 {{- $shortModuleName := (index ($fullModuleName | strings.SplitN "-" 3) 2) -}}
@@ -18,6 +18,7 @@ tags:
 custom_edit_url: https://github.com/cloudposse/{{ $fullModuleName }}/edit/master/README.md
 ---
 
+
 # Module: `{{ $shortModuleName }}`
 
 {{- if $deprecated }}
@@ -75,7 +76,7 @@ custom_edit_url: https://github.com/cloudposse/{{ $fullModuleName }}/edit/master
 
 {{ if has (ds "config") "include" }}
 {{ range $file := (datasource "config").include -}}
-{{ (include "includes" $file) }}
+{{ (include "readmeIncludesDir" $file) }}
 {{- end }}
 {{- end }}
 {{- end }}