feat: adding CODEOWNERS file using maintainers

Author: Skarlso

apis/mpas/v1alpha1/repository_types.go

@@ -28,6 +28,21 @@ var (
 	ExistingRepositoryPolicyFail ExistingRepositoryPolicy = "fail"
 )
 
+// CommitTemplate defines information that is needed to create the CODEOWNERS file.
+type CommitTemplate struct {
+	Email string `json:"email"`
+	Name  string `json:"name"`
+
+	//+optional
+	Message string `json:"message,omitempty"`
+}
+
+// Maintainers defines information needed
+type Maintainers struct {
+	Users          []string       `json:"users"`
+	CommitTemplate CommitTemplate `json:"commitTemplate"`
+}
+
 // RepositorySpec defines the desired state of Repository
 type RepositorySpec struct {
 	//+required
@@ -49,7 +64,7 @@ type RepositorySpec struct {
 	//+optional
 	Domain string `json:"domain,omitempty"`
 	//+optional
-	Maintainers []string `json:"maintainers,omitempty"`
+	Maintainers Maintainers `json:"maintainers,omitempty"`
 	//+optional
 	//+kubebuilder:default:=adopt
 	//+kubebuilder:validation:Enum=adopt;fail

apis/mpas/v1alpha1/zz_generated.deepcopy.go

@@ -68,9 +68,30 @@ spec:
                 default: true
                 type: boolean
               maintainers:
-                items:
-                  type: string
-                type: array
+                description: Maintainers defines information needed
+                properties:
+                  commitTemplate:
+                    description: CommitTemplate defines information that is needed
+                      to create the CODEOWNERS file.
+                    properties:
+                      email:
+                        type: string
+                      message:
+                        type: string
+                      name:
+                        type: string
+                    required:
+                    - email
+                    - name
+                    type: object
+                  users:
+                    items:
+                      type: string
+                    type: array
+                required:
+                - commitTemplate
+                - users
+                type: object
               owner:
                 type: string
               provider:

config/crd/bases/mpas.ocm.software_repositories.yaml

@@ -7,6 +7,7 @@ package gitea
 import (
 	"context"
 	"fmt"
+	"strings"
 
 	"code.gitea.io/sdk/gitea"
 	v1 "k8s.io/api/core/v1"
@@ -88,6 +89,34 @@ func (c *Client) CreateRepository(ctx context.Context, obj mpasv1alpha1.Reposito
 		return fmt.Errorf("failed to create repositroy: %w", err)
 	}
 
+	if len(obj.Spec.Maintainers.Users) != 0 {
+		content := strings.Builder{}
+
+		for _, m := range obj.Spec.Maintainers.Users {
+			_, _ = content.WriteString(fmt.Sprintf("%s\n", m))
+		}
+
+		_, _, err := client.CreateFile(obj.Spec.Owner, obj.Spec.RepositoryName, ".", gitea.CreateFileOptions{
+			FileOptions: gitea.FileOptions{
+				Message:    obj.Spec.Maintainers.CommitTemplate.Message,
+				BranchName: "main",
+				Author: gitea.Identity{
+					Name:  obj.Spec.Maintainers.CommitTemplate.Name,
+					Email: obj.Spec.Maintainers.CommitTemplate.Email,
+				},
+				Committer: gitea.Identity{
+					Name:  obj.Spec.Maintainers.CommitTemplate.Name,
+					Email: obj.Spec.Maintainers.CommitTemplate.Email,
+				},
+			},
+			Content: content.String(),
+		})
+
+		if err != nil {
+			return fmt.Errorf("failed to add CODEOWNERS file: %w", err)
+		}
+	}
+
 	return nil
 }
 

pkg/providers/gitea/gitea.go

@@ -7,6 +7,7 @@ package gogit
 import (
 	"context"
 	"fmt"
+	"strings"
 
 	"github.com/fluxcd/go-git-providers/gitprovider"
 	deliveryv1alpha1 "github.com/open-component-model/git-controller/apis/delivery/v1alpha1"
@@ -39,20 +40,29 @@ func CreateOrganizationRepository(ctx context.Context, gc gitprovider.Client, do
 
 	switch spec.ExistingRepositoryPolicy {
 	case mpasv1alpha1.ExistingRepositoryPolicyFail:
-		if _, err := gc.OrgRepositories().Create(ctx, ref, info); err != nil {
+		repo, err := gc.OrgRepositories().Create(ctx, ref, info)
+		if err != nil {
 			return fmt.Errorf("failed to create repository: %w", err)
 		}
 
+		if err := createCodeownersFile(ctx, repo, spec.Maintainers); err != nil {
+			return fmt.Errorf("failed to add CODEOWNERS file: %w", err)
+		}
+
 		logger.Info("successfully created organization repository", "domain", domain, "repository", spec.RepositoryName)
 	case mpasv1alpha1.ExistingRepositoryPolicyAdopt:
-		_, created, err := gc.OrgRepositories().Reconcile(ctx, ref, info)
+		repo, created, err := gc.OrgRepositories().Reconcile(ctx, ref, info)
 		if err != nil {
 			return fmt.Errorf("failed to reconcile repository: %w", err)
 		}
 
 		if !created {
 			logger.Info("using existing repository", "domain", domain, "repository", spec.RepositoryName)
 		} else {
+			if err := createCodeownersFile(ctx, repo, spec.Maintainers); err != nil {
+				return fmt.Errorf("failed to add CODEOWNERS file: %w", err)
+			}
+
 			logger.Info("successfully created organization repository", "domain", domain, "repository", spec.RepositoryName)
 		}
 	default:
@@ -86,20 +96,29 @@ func CreateUserRepository(ctx context.Context, gc gitprovider.Client, domain str
 
 	switch spec.ExistingRepositoryPolicy {
 	case mpasv1alpha1.ExistingRepositoryPolicyFail:
-		if _, err := gc.UserRepositories().Create(ctx, ref, info); err != nil {
+		repo, err := gc.UserRepositories().Create(ctx, ref, info)
+		if err != nil {
 			return fmt.Errorf("failed to create repository: %w", err)
 		}
 
+		if err := createCodeownersFile(ctx, repo, spec.Maintainers); err != nil {
+			return fmt.Errorf("failed to add CODEOWNERS file: %w", err)
+		}
+
 		logger.Info("successfully created user repository", "domain", domain, "repository", spec.RepositoryName)
 	case mpasv1alpha1.ExistingRepositoryPolicyAdopt:
-		_, created, err := gc.UserRepositories().Reconcile(ctx, ref, info)
+		repo, created, err := gc.UserRepositories().Reconcile(ctx, ref, info)
 		if err != nil {
 			return fmt.Errorf("failed to reconcile repository: %w", err)
 		}
 
 		if !created {
 			logger.Info("using existing repository", "domain", domain, "repository", spec.RepositoryName)
 		} else {
+			if err := createCodeownersFile(ctx, repo, spec.Maintainers); err != nil {
+				return fmt.Errorf("failed to add CODEOWNERS file: %w", err)
+			}
+
 			logger.Info("successfully created user repository", "domain", domain, "repository", spec.RepositoryName)
 		}
 	default:
@@ -194,3 +213,38 @@ func CreateUserPullRequest(ctx context.Context, gc gitprovider.Client, domain, b
 
 	return nil
 }
+
+// Repositories groups together a common functionality of both repository types.
+type Repositories interface {
+	Commits() gitprovider.CommitClient
+}
+
+func createCodeownersFile(ctx context.Context, repo Repositories, maintainers mpasv1alpha1.Maintainers) error {
+	if len(maintainers.Users) == 0 {
+		return nil
+	}
+
+	logger := log.FromContext(ctx)
+
+	content := strings.Builder{}
+
+	for _, m := range maintainers.Users {
+		_, _ = content.WriteString(fmt.Sprintf("%s\n", m))
+	}
+
+	files := []gitprovider.CommitFile{
+		{
+			Path:    gitprovider.StringVar("."),
+			Content: gitprovider.StringVar(content.String()),
+		},
+	}
+
+	commit, err := repo.Commits().Create(ctx, "main", "adding CODEOWNERS", files)
+	if err != nil {
+		return fmt.Errorf("failed to create CODEOWNERS file: %w", err)
+	}
+
+	logger.Info("successfully added CODEOWNERS", "url", commit.Get().URL)
+
+	return nil
+}