handle missing boilerplate file gracefully during scaffolding

Author: sarthaksarthak9

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"
@@ -82,6 +83,10 @@ func (s *apiScaffolder) Scaffold() error {
 	// Load the boilerplate
 	boilerplate, err := afero.ReadFile(s.fs.FS, filepath.Join("hack", "boilerplate.go.txt"))
 	if err != nil {
+		if errors.Is(err, afero.ErrFileNotFound) {
+			log.Printf("Warning: Boilerplate file 'hack/boilerplate.go.txt' not found. Please ensure it exists or update project settings if needed.")
+			boilerplate = []byte("")
+		}
 		return fmt.Errorf("error scaffolding API/controller: unable to load boilerplate: %w", err)
 	}
 

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

@@ -70,6 +70,7 @@ func (s *apiScaffolder) Scaffold() error {
 	boilerplate, err := afero.ReadFile(s.fs.FS, hack.DefaultBoilerplatePath)
 	if err != nil {
 		if errors.Is(err, afero.ErrFileNotFound) {
+			log.Println("Warning: Boilerplate file 'hack/boilerplate.go.txt' not found. Please ensure it exists or update project settings if needed.")
 			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,12 @@ 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.Printf("Warning: Boilerplate file 'hack/boilerplate.go.txt' not found. Please ensure it exists or update project settings if needed.")
+				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,10 @@ 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.Printf("Warning: Boilerplate file 'hack/boilerplate.go.txt' not found. Please ensure it exists or update project settings if needed.")
+			boilerplate = []byte("")
+		}
 		return fmt.Errorf("error scaffolding webhook: unable to load boilerplate: %w", err)
 	}