Merge branch 'main' into DBTP-1505-pipeline-generate-fast-deploy-2

uktrade · Jan 23, 2025 · 4a81831 · 4a81831
2 parents c2412f5 + d9bbe41
commit 4a81831
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 43 deletions.
diff --git a/dbt_platform_helper/COMMANDS.md b/dbt_platform_helper/COMMANDS.md
@@ -1,40 +1,40 @@
 # Commands Reference
 
 - [platform-helper](#platform-helper)
-- [platform-helper application](#platform-helper-application)
-- [platform-helper application container-stats](#platform-helper-application-container-stats)
-- [platform-helper application task-stats](#platform-helper-application-task-stats)
-- [platform-helper codebase](#platform-helper-codebase)
-- [platform-helper codebase prepare](#platform-helper-codebase-prepare)
-- [platform-helper codebase list](#platform-helper-codebase-list)
-- [platform-helper codebase build](#platform-helper-codebase-build)
-- [platform-helper codebase deploy](#platform-helper-codebase-deploy)
-- [platform-helper conduit](#platform-helper-conduit)
-- [platform-helper config](#platform-helper-config)
-- [platform-helper config validate](#platform-helper-config-validate)
-- [platform-helper config aws](#platform-helper-config-aws)
-- [platform-helper copilot](#platform-helper-copilot)
-- [platform-helper copilot make-addons](#platform-helper-copilot-make-addons)
-- [platform-helper environment](#platform-helper-environment)
-- [platform-helper environment offline](#platform-helper-environment-offline)
-- [platform-helper environment online](#platform-helper-environment-online)
-- [platform-helper environment generate](#platform-helper-environment-generate)
-- [platform-helper environment generate-terraform](#platform-helper-environment-generate-terraform)
-- [platform-helper generate](#platform-helper-generate)
-- [platform-helper pipeline](#platform-helper-pipeline)
-- [platform-helper pipeline generate](#platform-helper-pipeline-generate)
-- [platform-helper secrets](#platform-helper-secrets)
-- [platform-helper secrets copy](#platform-helper-secrets-copy)
-- [platform-helper secrets list](#platform-helper-secrets-list)
-- [platform-helper notify](#platform-helper-notify)
-- [platform-helper notify environment-progress](#platform-helper-notify-environment-progress)
-- [platform-helper notify add-comment](#platform-helper-notify-add-comment)
-- [platform-helper database](#platform-helper-database)
-- [platform-helper database dump](#platform-helper-database-dump)
-- [platform-helper database load](#platform-helper-database-load)
-- [platform-helper database copy](#platform-helper-database-copy)
-- [platform-helper version](#platform-helper-version)
-- [platform-helper version get-platform-helper-for-project](#platform-helper-version-get-platform-helper-for-project)
+  - [platform-helper application](#platform-helper-application)
+    - [platform-helper application container-stats](#platform-helper-application-container-stats)
+    - [platform-helper application task-stats](#platform-helper-application-task-stats)
+  - [platform-helper codebase](#platform-helper-codebase)
+    - [platform-helper codebase prepare](#platform-helper-codebase-prepare)
+    - [platform-helper codebase list](#platform-helper-codebase-list)
+    - [platform-helper codebase build](#platform-helper-codebase-build)
+    - [platform-helper codebase deploy](#platform-helper-codebase-deploy)
+  - [platform-helper conduit](#platform-helper-conduit)
+  - [platform-helper config](#platform-helper-config)
+    - [platform-helper config validate](#platform-helper-config-validate)
+    - [platform-helper config aws](#platform-helper-config-aws)
+  - [platform-helper copilot](#platform-helper-copilot)
+    - [platform-helper copilot make-addons](#platform-helper-copilot-make-addons)
+  - [platform-helper environment](#platform-helper-environment)
+    - [platform-helper environment offline](#platform-helper-environment-offline)
+    - [platform-helper environment online](#platform-helper-environment-online)
+    - [platform-helper environment generate](#platform-helper-environment-generate)
+    - [platform-helper environment generate-terraform](#platform-helper-environment-generate-terraform)
+  - [platform-helper generate](#platform-helper-generate)
+  - [platform-helper pipeline](#platform-helper-pipeline)
+    - [platform-helper pipeline generate](#platform-helper-pipeline-generate)
+  - [platform-helper secrets](#platform-helper-secrets)
+    - [platform-helper secrets copy](#platform-helper-secrets-copy)
+    - [platform-helper secrets list](#platform-helper-secrets-list)
+  - [platform-helper notify](#platform-helper-notify)
+    - [platform-helper notify environment-progress](#platform-helper-notify-environment-progress)
+    - [platform-helper notify add-comment](#platform-helper-notify-add-comment)
+  - [platform-helper database](#platform-helper-database)
+    - [platform-helper database dump](#platform-helper-database-dump)
+    - [platform-helper database load](#platform-helper-database-load)
+    - [platform-helper database copy](#platform-helper-database-copy)
+  - [platform-helper version](#platform-helper-version)
+    - [platform-helper version get-platform-helper-for-project](#platform-helper-version-get-platform-helper-for-project)
 
 # platform-helper
 

diff --git a/dbt_platform_helper/templates/COMMANDS.md.jinja b/dbt_platform_helper/templates/COMMANDS.md.jinja
@@ -1,8 +1,10 @@
 # Commands Reference
 
-{% for command in toc -%}
-- [{{ command }}](#{{ command.lower() | replace(" ", "-") }})
-{% endfor %}
+{% for meta in metadata -%}
+{% if meta.name -%}
+{{ meta.indent }}- [{{ meta.name }}](#{{ meta.name.lower() | replace(" ", "-") }})
+{% endif -%}
+{% endfor -%}
 
 {%- for meta in metadata +%}
 {% if meta.name -%}

diff --git a/tests/platform_helper/test-docs/expected_output.md b/tests/platform_helper/test-docs/expected_output.md
@@ -1,9 +1,9 @@
 # Commands Reference
 
 - [cli](#cli)
-- [cli hello](#cli-hello)
-- [cli argument-replacements](#cli-argument-replacements)
-- [cli option-replacements](#cli-option-replacements)
+  - [cli hello](#cli-hello)
+  - [cli argument-replacements](#cli-argument-replacements)
+  - [cli option-replacements](#cli-option-replacements)
 
 # cli
 

diff --git a/utils/create_command_docs.py b/utils/create_command_docs.py
@@ -37,12 +37,14 @@ class CommandMetadata(NamedTuple):
     parent_reference: str
     subcommands: Optional[Any]
     usage: str
+    indent: str
 
 
 def get_cmd_metadata(
     cmd: click.core.Command,
     parent: Optional[click.core.Context] = None,
     command_name: Optional[str] = None,
+    indent: str = "",
 ) -> Generator[CommandMetadata, None, None]:
     """
     Get command metadata recursively.
@@ -100,19 +102,19 @@ def get_cmd_metadata(
                 .split("\n"),
             )
         ),
+        indent=indent,
     )
 
     for sub in subcommands_names.values():
-        yield from get_cmd_metadata(sub, context, command_name)
+        yield from get_cmd_metadata(sub, context, command_name, f"{indent}  ")
 
 
 def create_docs(base_command, output):
     """Create Markdown documentation from Click command metadata."""
 
     templates = setup_templates()
     content = dict(
-        toc=[command.name for command in get_cmd_metadata(base_command)],
-        metadata=get_cmd_metadata(base_command),
+        metadata=list(get_cmd_metadata(base_command)),
     )
 
     with open(output, "w") as md_file: