handle missing boilerplate file gracefully during scaffolding

Author: migueleliasweb

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,21 @@ 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,10 @@ 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,14 @@ 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/internal/templates/makefile.go

@@ -123,7 +123,13 @@ manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and Cust
 .PHONY: generate
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	{{ if .BoilerplatePath -}}
-	$(CONTROLLER_GEN) object:headerFile={{printf "%q" .BoilerplatePath}} paths="./..."
+	@if [ -f {{ .BoilerplatePath }} ]; then \
+		$(CONTROLLER_GEN) object:headerFile={{printf "%q" .BoilerplatePath}} paths="./..."; \
+	else \
+		echo "Warning: Boilerplate file '{{ .BoilerplatePath }}' not found. Proceeding without it."; \
+		echo "You can create it later and regenerate code with the boilerplate using 'make generate'."; \
+		$(CONTROLLER_GEN) object paths="./..."; \
+	fi
 	{{- else -}}
 	$(CONTROLLER_GEN) object paths="./..."
 	{{- end }}

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

@@ -17,6 +17,7 @@ limitations under the License.
 package scaffolds
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 
@@ -76,6 +77,13 @@ func (s *webhookScaffolder) Scaffold() error {
 	// Load the boilerplate
 	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("")
+		}
 		return fmt.Errorf("error scaffolding webhook: unable to load boilerplate: %w", err)
 	}