Add 'Code generated by' comment

kubernetes · Jan 23, 2018 · 3a11997 · 3a11997
1 parent 3b2d540
commit 3a11997
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 18 deletions.
diff --git a/args/args.go b/args/args.go
@@ -23,6 +23,7 @@ import (
 	"fmt"
 	"io/ioutil"
 	"os"
+	"path"
 	"path/filepath"
 	"strconv"
 	"strings"
@@ -40,10 +41,11 @@ import (
 // before calling AddFlags.
 func Default() *GeneratorArgs {
 	return &GeneratorArgs{
-		OutputBase:              DefaultSourceTree(),
-		GoHeaderFilePath:        filepath.Join(DefaultSourceTree(), "k8s.io/gengo/boilerplate/boilerplate.go.txt"),
-		GeneratedBuildTag:       "ignore_autogenerated",
-		defaultCommandLineFlags: true,
+		OutputBase:                 DefaultSourceTree(),
+		GoHeaderFilePath:           filepath.Join(DefaultSourceTree(), "k8s.io/gengo/boilerplate/boilerplate.go.txt"),
+		GeneratedBuildTag:          "ignore_autogenerated",
+		GeneratedByCommentTemplate: "// This file was autogenerated by GENERATOR_NAME. Do not edit it manually!",
+		defaultCommandLineFlags:    true,
 	}
 }
 
@@ -64,6 +66,11 @@ type GeneratorArgs struct {
 	// Where to get copyright header text.
 	GoHeaderFilePath string
 
+	// If GeneratedByCommentTemplate is set, generate a "Code generated by" comment
+	// below the bloilerplate, of the format defined by this string.
+	// Any instances of "GENERATOR_NAME" will be replaced with the name of the code generator.
+	GeneratedByCommentTemplate string
+
 	// If true, only verify, don't write anything.
 	VerifyOnly bool
 
@@ -103,6 +110,16 @@ func (g *GeneratorArgs) LoadGoBoilerplate() ([]byte, error) {
 		return nil, err
 	}
 	b = bytes.Replace(b, []byte("YEAR"), []byte(strconv.Itoa(time.Now().Year())), -1)
+
+	if g.GeneratedByCommentTemplate != "" {
+		if len(b) != 0 {
+			b = append(b, byte('\n'))
+		}
+		generatorName := path.Base(os.Args[0])
+		generatedByComment := strings.Replace(g.GeneratedByCommentTemplate, "GENERATOR_NAME", generatorName, -1)
+		s := fmt.Sprintf("%s\n\n", generatedByComment)
+		b = append(b, []byte(s)...)
+	}
 	return b, nil
 }
 

diff --git a/examples/deepcopy-gen/generators/deepcopy.go b/examples/deepcopy-gen/generators/deepcopy.go
@@ -129,10 +129,6 @@ func Packages(context *generator.Context, arguments *args.GeneratorArgs) generat
 	inputs := sets.NewString(context.Inputs...)
 	packages := generator.Packages{}
 	header := append([]byte(fmt.Sprintf("// +build !%s\n\n", arguments.GeneratedBuildTag)), boilerplate...)
-	header = append(header, []byte(`
-	    // This file was autogenerated by deepcopy-gen. Do not edit it manually!
-
-		`)...)
 
 	boundingDirs := []string{}
 	if customArgs, ok := arguments.CustomArgs.(*CustomArgs); ok {

diff --git a/examples/defaulter-gen/generators/defaulter.go b/examples/defaulter-gen/generators/defaulter.go
@@ -203,11 +203,6 @@ func Packages(context *generator.Context, arguments *args.GeneratorArgs) generat
 
 	packages := generator.Packages{}
 	header := append([]byte(fmt.Sprintf("// +build !%s\n\n", arguments.GeneratedBuildTag)), boilerplate...)
-	header = append(header, []byte(
-		`
-// This file was autogenerated by defaulter-gen. Do not edit it manually!
-
-`)...)
 
 	// Accumulate pre-existing default functions.
 	// TODO: This is too ad-hoc.  We need a better way.

diff --git a/examples/set-gen/generators/sets.go b/examples/set-gen/generators/sets.go
@@ -53,11 +53,7 @@ func Packages(_ *generator.Context, arguments *args.GeneratorArgs) generator.Pac
 	return generator.Packages{&generator.DefaultPackage{
 		PackageName: "sets",
 		PackagePath: arguments.OutputPackagePath,
-		HeaderText: append(boilerplate, []byte(
-			`
-// This file was autogenerated by set-gen. Do not edit it manually!
-
-`)...),
+		HeaderText: boilerplate,
 		PackageDocumentation: []byte(
 			`// Package sets has auto-generated set types.
 `),