Skip to content

Add template for README with Terraform docs hook #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goruha merged 1 commit into from
Dec 5, 2025
Merged

Add template for README with Terraform docs hook #243

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions atmos.README.md.submodule.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 -}}