Merge pull request #4518 from sarthaksarthak9/boilerplate

✨ handle missing boilerplate file gracefully during scaffolding

Author: k8s-ci-robot

pkg/plugins/golang/deploy-image/v1alpha1/scaffolds/api.go

@@ -17,6 +17,7 @@ limitations under the License.
 package scaffolds
 
 import (
+	"errors"
 	"fmt"
 	"path/filepath"
 	"strings"
@@ -79,10 +80,22 @@ func (s *apiScaffolder) Scaffold() error {
 		return err
 	}
 
+	// Define the boilerplate file path
+	boilerplatePath := filepath.Join("hack", "boilerplate.go.txt")
+
 	// Load the boilerplate
-	boilerplate, err := afero.ReadFile(s.fs.FS, filepath.Join("hack", "boilerplate.go.txt"))
+	boilerplate, err := afero.ReadFile(s.fs.FS, boilerplatePath)
 	if err != nil {
-		return fmt.Errorf("error scaffolding API/controller: unable to load boilerplate: %w", err)
+		if errors.Is(err, afero.ErrFileNotFound) {
+			log.Warnf("Unable to find %s : %s .\n"+
+				"This file is used to generate the license header in the project.\n"+
+				"Note that controller-gen will also use this. Therefore, ensure that you "+
+				"add the license file or configure your project accordingly.",
+				boilerplatePath, err)
+			boilerplate = []byte("")
+		} else {
+			return fmt.Errorf("error scaffolding API/controller: unable to load boilerplate: %w", err)
+		}
 	}
 
 	// Initialize the machinery.Scaffold that will write the files to disk

pkg/plugins/golang/v4/scaffolds/api.go

@@ -70,6 +70,11 @@ func (s *apiScaffolder) Scaffold() error {
 	boilerplate, err := afero.ReadFile(s.fs.FS, hack.DefaultBoilerplatePath)
 	if err != nil {
 		if errors.Is(err, afero.ErrFileNotFound) {
+			log.Warnf("Unable to find %s: %s.\n"+
+				"This file is used to generate the license header in the project.\n"+
+				"Note that controller-gen will also use this. Therefore, ensure that you "+
+				"add the license file or configure your project accordingly.",
+				hack.DefaultBoilerplatePath, err)
 			boilerplate = []byte("")
 		} else {
 			return fmt.Errorf("error scaffolding API/controller: unable to load boilerplate: %w", err)

pkg/plugins/golang/v4/scaffolds/init.go

@@ -17,6 +17,7 @@ limitations under the License.
 package scaffolds
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 
@@ -114,7 +115,15 @@ func (s *initScaffolder) Scaffold() error {
 
 		boilerplate, err := afero.ReadFile(s.fs.FS, s.boilerplatePath)
 		if err != nil {
-			return err
+			if errors.Is(err, afero.ErrFileNotFound) {
+				log.Warnf("Unable to find %s: %s.\n"+"This file is used to generate the license header in the project.\n"+
+					"Note that controller-gen will also use this. Therefore, ensure that you "+
+					"add the license file or configure your project accordingly.",
+					s.boilerplatePath, err)
+				boilerplate = []byte("")
+			} else {
+				return fmt.Errorf("unable to load boilerplate: %w", err)
+			}
 		}
 		// Initialize the machinery.Scaffold that will write the files to disk
 		scaffold = machinery.NewScaffold(s.fs,

pkg/plugins/golang/v4/scaffolds/webhook.go

@@ -17,6 +17,7 @@ limitations under the License.
 package scaffolds
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 
@@ -76,7 +77,16 @@ func (s *webhookScaffolder) Scaffold() error {
 	// Load the boilerplate
 	boilerplate, err := afero.ReadFile(s.fs.FS, hack.DefaultBoilerplatePath)
 	if err != nil {
-		return fmt.Errorf("error scaffolding webhook: unable to load boilerplate: %w", err)
+		if errors.Is(err, afero.ErrFileNotFound) {
+			log.Warnf("Unable to find %s : %s .\n"+
+				"This file is used to generate the license header in the project.\n"+
+				"Note that controller-gen will also use this. Therefore, ensure that you "+
+				"add the license file or configure your project accordingly.",
+				hack.DefaultBoilerplatePath, err)
+			boilerplate = []byte("")
+		} else {
+			return fmt.Errorf("error scaffolding webhook: unable to load boilerplate: %w", err)
+		}
 	}
 
 	// Initialize the machinery.Scaffold that will write the files to disk