diff --git a/.github/workflows/housekeeping.yaml b/.github/workflows/housekeeping.yaml index 1a4fde9dd58..160769b71c9 100644 --- a/.github/workflows/housekeeping.yaml +++ b/.github/workflows/housekeeping.yaml @@ -153,6 +153,11 @@ jobs: --output-file="CONFIG.md" \ --template-files="/home/runner/work/apps/apps/templates/docs/CONFIG.md.gotmpl" \ --chart-search-root="${chart}" + helm-docs \ + --ignore-file=".helmdocsignore" \ + --output-file="app-readme.md" \ + --template-files="/home/runner/work/apps/apps/templates/docs/app-readme.md.gotmpl" \ + --chart-search-root="${chart}" fi done done diff --git a/templates/docs/README.md.gotmpl b/templates/docs/README.md.gotmpl index c0dbc69e517..b7ebaf694ea 100644 --- a/templates/docs/README.md.gotmpl +++ b/templates/docs/README.md.gotmpl @@ -68,6 +68,8 @@ All Rights Reserved - The TrueCharts Project {{ template "chart.description" . }} +{{ template "chart.deprecationWarning" . }} + {{ template "custom.notes" . }} {{ template "chart.sourcesSection" . }} diff --git a/templates/docs/app-readme.md.gotmpl b/templates/docs/app-readme.md.gotmpl new file mode 100644 index 00000000000..bccf3a2f9a4 --- /dev/null +++ b/templates/docs/app-readme.md.gotmpl @@ -0,0 +1,6 @@ +{{- define "custom.custom.app-readme" -}} +{{ template "chart.deprecationWarning" . }} +{{ template "chart.description" . }} +{{- end -}} + +{{ template "custom.custom.configuration" . }}