(rbac) fix: improve role comment clarity by replacing {{ .ProjectName }} with rendered project name

Author: camilamacedo86

docs/book/src/cronjob-tutorial/testdata/project/config/rbac/kustomization.yaml

@@ -20,7 +20,7 @@ resources:
 - metrics_reader_role.yaml
 # For each CRD, "Admin", "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
-# not used by the {{ .ProjectName }} itself. You can comment the following lines
+# not used by the project itself. You can comment the following lines
 # if you do not want those helpers be installed with your Project.
 - cronjob_admin_role.yaml
 - cronjob_editor_role.yaml

docs/book/src/getting-started/testdata/project/config/rbac/kustomization.yaml

@@ -20,7 +20,7 @@ resources:
 - metrics_reader_role.yaml
 # For each CRD, "Admin", "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
-# not used by the {{ .ProjectName }} itself. You can comment the following lines
+# not used by the project itself. You can comment the following lines
 # if you do not want those helpers be installed with your Project.
 - memcached_admin_role.yaml
 - memcached_editor_role.yaml

docs/book/src/multiversion-tutorial/testdata/project/config/rbac/kustomization.yaml

@@ -20,7 +20,7 @@ resources:
 - metrics_reader_role.yaml
 # For each CRD, "Admin", "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
-# not used by the {{ .ProjectName }} itself. You can comment the following lines
+# not used by the project itself. You can comment the following lines
 # if you do not want those helpers be installed with your Project.
 - cronjob_admin_role.yaml
 - cronjob_editor_role.yaml

pkg/plugins/common/kustomize/v2/scaffolds/api.go

@@ -100,10 +100,12 @@ func (s *apiScaffolder) Scaffold() error {
 			}
 		}
 
+		comment := fmt.Sprintf(adminEditViewRulesCommentFragment, s.config.GetProjectName())
+
 		// Add scaffolded CRD Admin, Editor and Viewer roles in config/rbac/kustomization.yaml
 		rbacKustomizeFilePath := "config/rbac/kustomization.yaml"
 		err = pluginutil.AppendCodeIfNotExist(rbacKustomizeFilePath,
-			adminEditViewRulesCommentFragment)
+			comment)
 		if err != nil {
 			log.Errorf("Unable to append the admin/edit/view roles comment in the file "+
 				"%s.", rbacKustomizeFilePath)
@@ -112,7 +114,7 @@ func (s *apiScaffolder) Scaffold() error {
 		if s.config.IsMultiGroup() && s.resource.Group != "" {
 			crdName = strings.ToLower(s.resource.Group) + "_" + crdName
 		}
-		err = pluginutil.InsertCodeIfNotExist(rbacKustomizeFilePath, adminEditViewRulesCommentFragment,
+		err = pluginutil.InsertCodeIfNotExist(rbacKustomizeFilePath, comment,
 			fmt.Sprintf("\n- %[1]s_admin_role.yaml\n- %[1]s_editor_role.yaml\n- %[1]s_viewer_role.yaml", crdName))
 		if err != nil {
 			log.Errorf("Unable to add Admin, Editor and Viewer roles in the file "+
@@ -134,5 +136,5 @@ func (s *apiScaffolder) Scaffold() error {
 
 const adminEditViewRulesCommentFragment = `# For each CRD, "Admin", "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
-# not used by the {{ .ProjectName }} itself. You can comment the following lines
+# not used by the %s itself. You can comment the following lines
 # if you do not want those helpers be installed with your Project.`

testdata/project-v4-multigroup/config/rbac/kustomization.yaml

@@ -20,7 +20,7 @@ resources:
 - metrics_reader_role.yaml
 # For each CRD, "Admin", "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
-# not used by the {{ .ProjectName }} itself. You can comment the following lines
+# not used by the project-v4-multigroup itself. You can comment the following lines
 # if you do not want those helpers be installed with your Project.
 - example.com_wordpress_admin_role.yaml
 - example.com_wordpress_editor_role.yaml

testdata/project-v4-with-plugins/config/rbac/kustomization.yaml

@@ -20,7 +20,7 @@ resources:
 - metrics_reader_role.yaml
 # For each CRD, "Admin", "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
-# not used by the {{ .ProjectName }} itself. You can comment the following lines
+# not used by the project-v4-with-plugins itself. You can comment the following lines
 # if you do not want those helpers be installed with your Project.
 - wordpress_admin_role.yaml
 - wordpress_editor_role.yaml

testdata/project-v4/config/rbac/kustomization.yaml

@@ -20,7 +20,7 @@ resources:
 - metrics_reader_role.yaml
 # For each CRD, "Admin", "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
-# not used by the {{ .ProjectName }} itself. You can comment the following lines
+# not used by the project-v4 itself. You can comment the following lines
 # if you do not want those helpers be installed with your Project.
 - admiral_admin_role.yaml
 - admiral_editor_role.yaml