pkg/scaffold/helm/chart.go: comment to explain decision not to use hy…

…phens in scaffolded chart name
operator-framework · Feb 4, 2019 · dddd92d · dddd92d
1 parent ffc48cf
commit dddd92d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/pkg/scaffold/helm/chart.go b/pkg/scaffold/helm/chart.go
@@ -130,6 +130,9 @@ func scaffoldChart(destDir, apiVersion, kind string) (*scaffold.Resource, *chart
 	}
 
 	chartfile := &chart.Metadata{
+		// Many helm charts use hyphenated names, but we chose not to because
+		// of the issues related to how hyphens are interpreted in templates.
+		// See https://github.com/helm/helm/issues/2192
 		Name:        r.LowerKind,
 		Description: "A Helm chart for Kubernetes",
 		Version:     "0.1.0",