Skip to content

Commit e9844ae

Browse files
committed
inject github repo README into helm chart README
1 parent 4204757 commit e9844ae

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

.github/workflows/helm-docs.yaml

+2-4
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ jobs:
2727
- name: Run helm-docs
2828
run: |
2929
cd helm/
30-
helm-docs --template-files=README.md.gotmpl --output-file=README.md
31-
helm-docs --template-files=configuration-reference.md.gotmpl --sort-values-order=file --output-file=configuration-reference.md
30+
helm-docs --template-files=helm-docs/README.md.gotmpl --output-file=README.md
31+
helm-docs --template-files=helm-docs/configuration-reference.md.gotmpl --sort-values-order=file --output-file=configuration-reference.md
3232
mv configuration-reference.md ../docs/configuration-reference.md
3333
3434
# Commit and push changes to the same branch
@@ -42,8 +42,6 @@ jobs:
4242
4343
# Add and commit changes
4444
git pull
45-
#cleanup
46-
git rm helm/configuration-reference.md
4745
git add helm/README.md docs/configuration-reference.md
4846
git commit -m "Update helm docs" || echo "No changes to commit"
4947

helm/README.md.gotmpl renamed to helm/helm-docs/README.md.gotmpl

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
{{- define "chart.githubReadme" -}}
2+
{{- if .Files.Get "../README.md" -}}
3+
{{ .Files.Get "../README.md" | nindent 0 }}
4+
{{- end -}}
5+
{{- end -}}
6+
17
{{ template "chart.header" . }}
28
{{ template "chart.deprecationWarning" . }}
39

@@ -7,6 +13,8 @@
713

814
{{ template "chart.homepageLine" . }}
915

16+
{{ template "chart.githubReadme" . }}
17+
1018
{{ template "chart.maintainersSection" . }}
1119

1220
{{ template "chart.sourcesSection" . }}

0 commit comments

Comments
 (0)