✨ warning comment on PROJECT file (kubernetes-sigs#3137)

* warning comment on PROJECT file

* make generate

* add link

pkg/config/store/yaml/store.go

@@ -31,6 +31,13 @@ import (
 const (
 	// DefaultPath is the default path for the configuration file
 	DefaultPath = "PROJECT"
+
+	// Comment for 'PROJECT' config file
+	commentStr = `# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
+`
 )
 
 // yamlStore implements store.Store using a YAML file as the storage backend
@@ -133,6 +140,9 @@ func (s yamlStore) SaveTo(path string) error {
 		return store.SaveError{Err: fmt.Errorf("unable to marshal to YAML: %w", err)}
 	}
 
+	// Prepend warning comment for the 'PROJECT' file
+	content = append([]byte(commentStr), content...)
+
 	// Write the marshalled configuration
 	err = afero.WriteFile(s.fs, path, content, 0600)
 	if err != nil {

pkg/config/store/yaml/store_test.go

@@ -86,7 +86,7 @@ layout: ""
 
 	Context("Load", func() {
 		It("should load the Config from an existing file at the default path", func() {
-			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(v2File), os.ModePerm)).To(Succeed())
+			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(commentStr+v2File), os.ModePerm)).To(Succeed())
 
 			Expect(s.Load()).To(Succeed())
 			Expect(s.fs).NotTo(BeNil())
@@ -102,23 +102,23 @@ layout: ""
 		})
 
 		It("should fail if unable to identify the version of the file at the default path", func() {
-			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(unversionedFile), os.ModePerm)).To(Succeed())
+			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(commentStr+unversionedFile), os.ModePerm)).To(Succeed())
 
 			err := s.Load()
 			Expect(err).To(HaveOccurred())
 			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
 		})
 
 		It("should fail if unable to create a Config for the version of the file at the default path", func() {
-			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(nonexistentVersionFile), os.ModePerm)).To(Succeed())
+			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(commentStr+nonexistentVersionFile), os.ModePerm)).To(Succeed())
 
 			err := s.Load()
 			Expect(err).To(HaveOccurred())
 			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
 		})
 
 		It("should fail if unable to unmarshal the file at the default path", func() {
-			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(wrongFile), os.ModePerm)).To(Succeed())
+			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(commentStr+wrongFile), os.ModePerm)).To(Succeed())
 
 			err := s.Load()
 			Expect(err).To(HaveOccurred())
@@ -128,7 +128,7 @@ layout: ""
 
 	Context("LoadFrom", func() {
 		It("should load the Config from an existing file from the specified path", func() {
-			Expect(afero.WriteFile(s.fs, path, []byte(v2File), os.ModePerm)).To(Succeed())
+			Expect(afero.WriteFile(s.fs, path, []byte(commentStr+v2File), os.ModePerm)).To(Succeed())
 
 			Expect(s.LoadFrom(path)).To(Succeed())
 			Expect(s.fs).NotTo(BeNil())
@@ -144,23 +144,23 @@ layout: ""
 		})
 
 		It("should fail if unable to identify the version of the file at the specified path", func() {
-			Expect(afero.WriteFile(s.fs, path, []byte(unversionedFile), os.ModePerm)).To(Succeed())
+			Expect(afero.WriteFile(s.fs, path, []byte(commentStr+unversionedFile), os.ModePerm)).To(Succeed())
 
 			err := s.LoadFrom(path)
 			Expect(err).To(HaveOccurred())
 			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
 		})
 
 		It("should fail if unable to create a Config for the version of the file at the specified path", func() {
-			Expect(afero.WriteFile(s.fs, path, []byte(nonexistentVersionFile), os.ModePerm)).To(Succeed())
+			Expect(afero.WriteFile(s.fs, path, []byte(commentStr+nonexistentVersionFile), os.ModePerm)).To(Succeed())
 
 			err := s.LoadFrom(path)
 			Expect(err).To(HaveOccurred())
 			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
 		})
 
 		It("should fail if unable to unmarshal the file at the specified path", func() {
-			Expect(afero.WriteFile(s.fs, path, []byte(wrongFile), os.ModePerm)).To(Succeed())
+			Expect(afero.WriteFile(s.fs, path, []byte(commentStr+wrongFile), os.ModePerm)).To(Succeed())
 
 			err := s.LoadFrom(path)
 			Expect(err).To(HaveOccurred())
@@ -175,7 +175,7 @@ layout: ""
 
 			cfgBytes, err := afero.ReadFile(s.fs, DefaultPath)
 			Expect(err).NotTo(HaveOccurred())
-			Expect(string(cfgBytes)).To(Equal(v2File))
+			Expect(string(cfgBytes)).To(Equal(commentStr + v2File))
 		})
 
 		It("should succeed for a valid config that must not exist", func() {
@@ -185,7 +185,7 @@ layout: ""
 
 			cfgBytes, err := afero.ReadFile(s.fs, DefaultPath)
 			Expect(err).NotTo(HaveOccurred())
-			Expect(string(cfgBytes)).To(Equal(v2File))
+			Expect(string(cfgBytes)).To(Equal(commentStr + v2File))
 		})
 
 		It("should fail for an empty config", func() {
@@ -212,8 +212,7 @@ layout: ""
 
 			cfgBytes, err := afero.ReadFile(s.fs, path)
 			Expect(err).NotTo(HaveOccurred())
-			Expect(string(cfgBytes)).To(Equal(`version: "2"
-`))
+			Expect(string(cfgBytes)).To(Equal(commentStr + v2File))
 		})
 
 		It("should succeed for a valid config that must not exist", func() {
@@ -223,7 +222,7 @@ layout: ""
 
 			cfgBytes, err := afero.ReadFile(s.fs, path)
 			Expect(err).NotTo(HaveOccurred())
-			Expect(string(cfgBytes)).To(Equal(v2File))
+			Expect(string(cfgBytes)).To(Equal(commentStr + v2File))
 		})
 
 		It("should fail for an empty config", func() {

testdata/project-v2/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 repo: sigs.k8s.io/kubebuilder/testdata/project-v2
 resources:

testdata/project-v3-config/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 componentConfig: true
 domain: testproject.org
 layout:

testdata/project-v3-declarative-v1/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v3

testdata/project-v3-multigroup/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v3

testdata/project-v3-with-deploy-image/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v3

testdata/project-v3-with-grafana/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v3

testdata/project-v3/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v3

testdata/project-v4-config/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 componentConfig: true
 domain: testproject.org
 layout:

testdata/project-v4-declarative-v1/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v4-alpha

testdata/project-v4-multigroup/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v4-alpha

testdata/project-v4-with-deploy-image/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v4-alpha

testdata/project-v4-with-grafana/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v3

testdata/project-v4/PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v4-alpha