Merge pull request #46 from matheusfm/feature/name-template

add chart name template

Author: norwoodj

README.md

@@ -87,6 +87,7 @@ The templates generated by the tool are shown below, and can be included in your
 | Name | Description |
 |------|-------------|
 | chart.header              | The main heading of the generated markdown file |
+| chart.name                | The _name_ field from the chart's `Chart.yaml` file |
 | chart.deprecationWarning  | A deprecation warning which is displayed when the _deprecated_ field from the chart's `Chart.yaml` file is `true` |
 | chart.description         | A description line containing the _description_ field from the chart's `Chart.yaml` file, or "" if that field is not set |
 | chart.version             | The _version_ field from the chart's `Chart.yaml` file |

example-charts/custom-template/README.md

@@ -12,6 +12,15 @@ aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in volup
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
 culpa qui officia deserunt mollit anim id est laborum.
 
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```console
+$ helm repo add foo-bar http://charts.foo-bar.com
+$ helm install my-release foo-bar/custom-template
+```
+
 ## Requirements
 
 | Repository | Name | Version |

example-charts/custom-template/README.md.gotmpl

@@ -11,6 +11,15 @@ aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in volup
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
 culpa qui officia deserunt mollit anim id est laborum.
 
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```console
+$ helm repo add foo-bar http://charts.foo-bar.com
+$ helm install my-release foo-bar/{{ template "chart.name" . }}
+```
+
 {{ template "chart.requirementsSection" . }}
 
 {{ template "chart.valuesSection" . }}

example-charts/full-template/README.md

@@ -4,6 +4,10 @@
 
 > **:exclamation: This Helm Chart is deprecated!**
 
+## `chart.name`
+
+full-template
+
 ## `chart.description`
 
 A chart for showing every README-element

example-charts/full-template/README.md.gotmpl

@@ -10,6 +10,10 @@
 
 {{ template "chart.deprecationWarning" . }}
 
+## `chart.name`
+
+{{ template "chart.name" . }}
+
 ## `chart.description`
 
 {{ template "chart.description" . }}

pkg/document/template.go

@@ -31,6 +31,15 @@ const defaultDocumentationTemplate = `{{ template "chart.header" . }}
 {{ template "chart.valuesSection" . }}
 `
 
+func getNameTemplate() string {
+	nameBuilder := strings.Builder{}
+	nameBuilder.WriteString(`{{ define "chart.name" }}`)
+	nameBuilder.WriteString("{{ .Name }}")
+	nameBuilder.WriteString("{{ end }}")
+
+	return nameBuilder.String()
+}
+
 func getHeaderTemplate() string {
 	headerTemplateBuilder := strings.Builder{}
 	headerTemplateBuilder.WriteString(`{{ define "chart.header" }}`)
@@ -235,6 +244,7 @@ func getDocumentationTemplates(chartDirectory string) ([]string, error) {
 	}
 
 	return []string{
+		getNameTemplate(),
 		getHeaderTemplate(),
 		getDeprecatedTemplate(),
 		getAppVersionTemplate(),