From be43318dfbd14290a6f9b05b809c74f42673aa2d Mon Sep 17 00:00:00 2001
From: Igor Rodionov <496956+goruha@users.noreply.github.com>
Date: Fri, 5 Dec 2025 13:42:12 +0300
Subject: [PATCH] Add template for README with Terraform docs hook

---
 atmos.README.md.submodule.gotmpl | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 atmos.README.md.submodule.gotmpl

diff --git a/atmos.README.md.submodule.gotmpl b/atmos.README.md.submodule.gotmpl
new file mode 100644
index 00000000..bfdc2fb9
--- /dev/null
+++ b/atmos.README.md.submodule.gotmpl
@@ -0,0 +1,18 @@
+{{- defineDatasource "config" .Env.README_YAML -}}
+{{- $readme_file := (ds "config").readme | file.Read -}}
+
+{{- $parts := strings.Split "<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->" $readme_file -}}
+
+{{- index $parts 0 -}}
+
+{{ if has (ds "config") "terraform_docs" }}
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+<!-- markdownlint-disable -->
+{{ (ds "config").terraform_docs }}
+<!-- markdownlint-restore -->
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+{{ end }}
+
+{{- $parts := strings.Split "<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->" $readme_file -}}
+
+{{- index $parts 1 -}}