Ensure generated code has consistent comments

eksctl-io · Oct 23, 2018 · da82279 · da82279
1 parent e9b7bc1
commit da82279
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/cmd/eksctl/version_generate.go b/cmd/eksctl/version_generate.go
@@ -13,7 +13,7 @@ func main() {
 		"// +build release",
 		"",
 		"package main",
-		"// this file was generated by version_generate.go",
+		"// This file was generated by version_generate.go; DO NOT EDIT.",
 		`var builtAt  = "" // will be set by goreleaser tool`,
 		`var gitCommit = "" // will be set by goreleaser tool`,
 		fmt.Sprintf("var gitTag = %q", os.Getenv("RELEASE_GIT_TAG")),

diff --git a/pkg/ami/static_resolver_ami_generate.go b/pkg/ami/static_resolver_ami_generate.go
@@ -22,6 +22,9 @@ func main() {
 
 	f := NewFile("ami")
 
+	f.Comment("This file was generated by static_resolver_ami_generate.go; DO NOT EDIT.")
+	f.Line()
+
 	d := Dict{}
 
 	client := newMultiRegionClient()
@@ -45,7 +48,7 @@ func main() {
 		d[Lit(family)] = Block(familyImages)
 	}
 
-	f.Comment("StaticImages is a map that holds the list of AMIs to be used by for static resolution, it is generated by static_resolver_ami_generate.go")
+	f.Comment("StaticImages is a map that holds the list of AMIs to be used by for static resolution")
 
 	f.Var().Id("StaticImages").Op("=").
 		Map(String()).Map(Int()).Map(String()).String().Values(d)

diff --git a/pkg/nodebootstrap/maxpods_generate.go b/pkg/nodebootstrap/maxpods_generate.go
@@ -18,7 +18,9 @@ const maxPodsPerNodeTypeSourceText = "https://raw.github.com/awslabs/amazon-eks-
 func main() {
 	f := NewFile("nodebootstrap")
 
-	f.Comment("Generated from " + maxPodsPerNodeTypeSourceText)
+	f.Comment("This file was generated by maxpods_generate.go; DO NOT EDIT.")
+	f.Line()
+	f.Comment("Source: " + maxPodsPerNodeTypeSourceText)
 
 	d := Dict{}