feat: Add template support for auto-configured repository CR names

zakisk · chmouel · commit 1ba08cf18363 · 2025-08-11T10:50:26.000+02:00
This commit introduces the ability to customize Repository custom resource names when auto-configuring new GitHub repositories using configurable templates with placeholder variables. Changes: • Add `auto-configure-repo-repository-template` configuration setting • Support `{{repo_owner}}` and `{{repo_name}}` template variables • Implement template processing in repository auto-configuration flow • Add comprehensive documentation with examples Configuration: The new `auto-configure-repo-repository-template` setting allows users to define custom naming patterns for automatically created Repository CRs. Supported template variables: - `{{repo_owner}}`: GitHub repository owner/organization name - `{{repo_name}}`: GitHub repository name Examples: - Template: `{{repo_owner}}-{{repo_name}}-repo-cr` - Repository: `https://github.com/acme/webapp` - Generated CR name: `acme-webapp-repo-cr` Backward compatibility: If no template is specified, the system falls back to the existing default format: `{{repo_name}}-repo-cr` This enhancement provides organizations with flexible naming conventions that can align with their existing Kubernetes resource management practices while maintaining the convenience of automatic repository setup. Signed-off-by: Zaki Shaikh <zashaikh@redhat.com>
diff --git a/config/302-pac-configmap.yaml b/config/302-pac-configmap.yaml
@@ -139,12 +139,18 @@ data:
   # namespace and repository CR, supported only with GitHub App
   auto-configure-new-github-repo: "false"
 
-  # add a template to generate name for namespace for your auto configured
-  # github repo supported fields are repo_owner, repo_name eg. if defined as
-  # `{{repo_owner}}-{{repo_name}}-ci`, then namespace generated for repository
-  # https://github.com/owner/repo will be `owner-repo-ci`
+  # Add a template to generate the name for a Repository CR for an auto-configured
+  # GitHub repository. Supported fields are `repo_owner` and `repo_name`. e.g.,
+  # if defined as `{{repo_owner}}-{{repo_name}}-repo-cr`, the generated CR name for
+  # https://github.com/owner/test will be `owner-test-repo-cr`
   auto-configure-repo-namespace-template: ""
 
+  # add a template to generate name for repository for your auto configured
+  # github repo. supported fields are repo_owner, repo_name eg. if defined as
+  # `{{repo_owner}}-{{repo_name}}-repo-cr`, then repository CR generated for  git repository
+  # https://github.com/owner/test will be `owner-test-repo-cr`
+  auto-configure-repo-repository-template: ""
+
   # Enable or disable the feature to rerun the CI if push event happens on
   # a pull request
   #
diff --git a/docs/content/docs/install/settings.md b/docs/content/docs/install/settings.md
@@ -124,6 +124,19 @@ There is a few things you can configure through the config map
 
   `https://github.com/owner/repo` will be `owner-repo-ci`
 
+* `auto-configure-repo-repository-template`
+
+  If `auto-configure-new-github-repo` is enabled then you can provide a template
+  for generating the name for your new repository custom resource. By default, the repository custom resource name will be generated using this format `{{repo_name}}-repo-cr`.
+
+  You can override the default using the following variables
+
+  * `{{repo_owner}}`: The repository owner.
+  * `{{repo_name}}`: The repository name.
+  For example, if the template is defined as `{{repo_owner}}-{{repo_name}}-repo-cr`,
+  then the Repository CR name generated for the repository
+  `https://github.com/owner/test` will be `owner-test-repo-cr`
+
 * `remember-ok-to-test`
 
   If `remember-ok-to-test` is true then if `ok-to-test` is done on pull request then in
diff --git a/pkg/params/settings/config.go b/pkg/params/settings/config.go
@@ -48,16 +48,17 @@ type HubCatalog struct {
 // if there is a change performed on the default value,
 // update the same on "config/302-pac-configmap.yaml".
 type Settings struct {
-	ApplicationName                    string `default:"Pipelines as Code CI" json:"application-name"`
-	HubCatalogs                        *sync.Map
-	RemoteTasks                        bool   `default:"true"                                json:"remote-tasks"`
-	MaxKeepRunsUpperLimit              int    `json:"max-keep-run-upper-limit"`
-	DefaultMaxKeepRuns                 int    `json:"default-max-keep-runs"`
-	BitbucketCloudCheckSourceIP        bool   `default:"true"                                json:"bitbucket-cloud-check-source-ip"`
-	BitbucketCloudAdditionalSourceIP   string `json:"bitbucket-cloud-additional-source-ip"`
-	TektonDashboardURL                 string `json:"tekton-dashboard-url"`
-	AutoConfigureNewGitHubRepo         bool   `default:"false"                               json:"auto-configure-new-github-repo"`
-	AutoConfigureRepoNamespaceTemplate string `json:"auto-configure-repo-namespace-template"`
+	ApplicationName                     string `default:"Pipelines as Code CI" json:"application-name"`
+	HubCatalogs                         *sync.Map
+	RemoteTasks                         bool   `default:"true"                                 json:"remote-tasks"`
+	MaxKeepRunsUpperLimit               int    `json:"max-keep-run-upper-limit"`
+	DefaultMaxKeepRuns                  int    `json:"default-max-keep-runs"`
+	BitbucketCloudCheckSourceIP         bool   `default:"true"                                 json:"bitbucket-cloud-check-source-ip"`
+	BitbucketCloudAdditionalSourceIP    string `json:"bitbucket-cloud-additional-source-ip"`
+	TektonDashboardURL                  string `json:"tekton-dashboard-url"`
+	AutoConfigureNewGitHubRepo          bool   `default:"false"                                json:"auto-configure-new-github-repo"`
+	AutoConfigureRepoNamespaceTemplate  string `json:"auto-configure-repo-namespace-template"`
+	AutoConfigureRepoRepositoryTemplate string `json:"auto-configure-repo-repository-template"`
 
 	SecretAutoCreation               bool   `default:"true"                             json:"secret-auto-create"`
 	SecretGHAppRepoScoped            bool   `default:"true"                             json:"secret-github-app-token-scoped"`
diff --git a/pkg/params/settings/config_test.go b/pkg/params/settings/config_test.go
@@ -52,55 +52,57 @@ func TestSyncConfig(t *testing.T) {
 		{
 			name: "override values",
 			configMap: map[string]string{
-				"application-name":                       "pac-pac",
-				"remote-tasks":                           "false",
-				"max-keep-run-upper-limit":               "10",
-				"default-max-keep-runs":                  "5",
-				"bitbucket-cloud-check-source-ip":        "false",
-				"bitbucket-cloud-additional-source-ip":   "some-ip",
-				"tekton-dashboard-url":                   "https://tekton-dashboard",
-				"auto-configure-new-github-repo":         "true",
-				"auto-configure-repo-namespace-template": "template",
-				"secret-auto-create":                     "false",
-				"secret-github-app-token-scoped":         "false",
-				"secret-github-app-scope-extra-repos":    "extra-repos",
-				"error-log-snippet":                      "false",
-				"error-detection-from-container-logs":    "false",
-				"error-detection-max-number-of-lines":    "100",
-				"error-detection-simple-regexp":          "^(?P<filename>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+)?([ ]*)?(?P<error>.*)",
-				"custom-console-name":                    "custom-console",
-				"custom-console-url":                     "https://custom-console",
-				"custom-console-url-pr-details":          "https://custom-console-pr-details",
-				"custom-console-url-pr-tasklog":          "https://custom-console-pr-tasklog",
-				"custom-console-url-namespace":           "https://custom-console-namespace",
-				"remember-ok-to-test":                    "false",
-				"skip-push-event-for-pr-commits":         "true",
+				"application-name":                        "pac-pac",
+				"remote-tasks":                            "false",
+				"max-keep-run-upper-limit":                "10",
+				"default-max-keep-runs":                   "5",
+				"bitbucket-cloud-check-source-ip":         "false",
+				"bitbucket-cloud-additional-source-ip":    "some-ip",
+				"tekton-dashboard-url":                    "https://tekton-dashboard",
+				"auto-configure-new-github-repo":          "true",
+				"auto-configure-repo-namespace-template":  "template",
+				"auto-configure-repo-repository-template": "template",
+				"secret-auto-create":                      "false",
+				"secret-github-app-token-scoped":          "false",
+				"secret-github-app-scope-extra-repos":     "extra-repos",
+				"error-log-snippet":                       "false",
+				"error-detection-from-container-logs":     "false",
+				"error-detection-max-number-of-lines":     "100",
+				"error-detection-simple-regexp":           "^(?P<filename>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+)?([ ]*)?(?P<error>.*)",
+				"custom-console-name":                     "custom-console",
+				"custom-console-url":                      "https://custom-console",
+				"custom-console-url-pr-details":           "https://custom-console-pr-details",
+				"custom-console-url-pr-tasklog":           "https://custom-console-pr-tasklog",
+				"custom-console-url-namespace":            "https://custom-console-namespace",
+				"remember-ok-to-test":                     "false",
+				"skip-push-event-for-pr-commits":          "true",
 			},
 			expectedStruct: Settings{
-				ApplicationName:                    "pac-pac",
-				HubCatalogs:                        nil,
-				RemoteTasks:                        false,
-				MaxKeepRunsUpperLimit:              10,
-				DefaultMaxKeepRuns:                 5,
-				BitbucketCloudCheckSourceIP:        false,
-				BitbucketCloudAdditionalSourceIP:   "some-ip",
-				TektonDashboardURL:                 "https://tekton-dashboard",
-				AutoConfigureNewGitHubRepo:         true,
-				AutoConfigureRepoNamespaceTemplate: "template",
-				SecretAutoCreation:                 false,
-				SecretGHAppRepoScoped:              false,
-				SecretGhAppTokenScopedExtraRepos:   "extra-repos",
-				ErrorLogSnippet:                    false,
-				ErrorDetection:                     false,
-				ErrorDetectionNumberOfLines:        100,
-				ErrorDetectionSimpleRegexp:         "^(?P<filename>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+)?([ ]*)?(?P<error>.*)",
-				CustomConsoleName:                  "custom-console",
-				CustomConsoleURL:                   "https://custom-console",
-				CustomConsolePRdetail:              "https://custom-console-pr-details",
-				CustomConsolePRTaskLog:             "https://custom-console-pr-tasklog",
-				CustomConsoleNamespaceURL:          "https://custom-console-namespace",
-				RememberOKToTest:                   false,
-				SkipPushEventForPRCommits:          true,
+				ApplicationName:                     "pac-pac",
+				HubCatalogs:                         nil,
+				RemoteTasks:                         false,
+				MaxKeepRunsUpperLimit:               10,
+				DefaultMaxKeepRuns:                  5,
+				BitbucketCloudCheckSourceIP:         false,
+				BitbucketCloudAdditionalSourceIP:    "some-ip",
+				TektonDashboardURL:                  "https://tekton-dashboard",
+				AutoConfigureNewGitHubRepo:          true,
+				AutoConfigureRepoNamespaceTemplate:  "template",
+				AutoConfigureRepoRepositoryTemplate: "template",
+				SecretAutoCreation:                  false,
+				SecretGHAppRepoScoped:               false,
+				SecretGhAppTokenScopedExtraRepos:    "extra-repos",
+				ErrorLogSnippet:                     false,
+				ErrorDetection:                      false,
+				ErrorDetectionNumberOfLines:         100,
+				ErrorDetectionSimpleRegexp:          "^(?P<filename>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+)?([ ]*)?(?P<error>.*)",
+				CustomConsoleName:                   "custom-console",
+				CustomConsoleURL:                    "https://custom-console",
+				CustomConsolePRdetail:               "https://custom-console-pr-details",
+				CustomConsolePRTaskLog:              "https://custom-console-pr-tasklog",
+				CustomConsoleNamespaceURL:           "https://custom-console-namespace",
+				RememberOKToTest:                    false,
+				SkipPushEventForPRCommits:           true,
 			},
 		},
 		{
diff --git a/pkg/provider/github/repository.go b/pkg/provider/github/repository.go
@@ -19,7 +19,10 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-const defaultNsTemplate = "%v-pipelines"
+const (
+	defaultNsTemplate   = "%v-pipelines"
+	defaultRepoTemplate = "%v-repo-cr"
+)
 
 func ConfigureRepository(ctx context.Context, run *params.Run, req *http.Request, payload string, pacInfo *info.PacOpts, logger *zap.SugaredLogger) (bool, bool, error) {
 	// check if repo auto configuration is enabled
@@ -48,16 +51,18 @@ func ConfigureRepository(ctx context.Context, run *params.Run, req *http.Request
 	}
 
 	logger.Infof("github: configuring repository cr for repo: %v", repoEvent.Repo.GetHTMLURL())
-	if err := createRepository(ctx, pacInfo.AutoConfigureRepoNamespaceTemplate, run.Clients, repoEvent, logger); err != nil {
+	nsTemplate := pacInfo.AutoConfigureRepoNamespaceTemplate
+	repoTemplate := pacInfo.AutoConfigureRepoRepositoryTemplate
+	if err := createRepository(ctx, nsTemplate, repoTemplate, run.Clients, repoEvent, logger); err != nil {
 		logger.Errorf("failed repository creation: %v", err)
 		return true, true, err
 	}
 
 	return true, true, nil
 }
 
-func createRepository(ctx context.Context, nsTemplate string, clients clients.Clients, gitEvent *github.RepositoryEvent, logger *zap.SugaredLogger) error {
-	repoNsName, err := generateNamespaceName(nsTemplate, gitEvent)
+func createRepository(ctx context.Context, nsTemplate, repoTemplate string, clients clients.Clients, gitEvent *github.RepositoryEvent, logger *zap.SugaredLogger) error {
+	repoNsName, repoCRName, err := generateNamespaceAndRepositoryName(nsTemplate, repoTemplate, gitEvent)
 	if err != nil {
 		return fmt.Errorf("failed to generate namespace for repo: %w", err)
 	}
@@ -84,7 +89,7 @@ func createRepository(ctx context.Context, nsTemplate string, clients clients.Cl
 	// create repository
 	repo := &v1alpha1.Repository{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      repoNsName,
+			Name:      repoCRName,
 			Namespace: repoNsName,
 		},
 		Spec: v1alpha1.RepositorySpec{
@@ -100,19 +105,29 @@ func createRepository(ctx context.Context, nsTemplate string, clients clients.Cl
 	return nil
 }
 
-func generateNamespaceName(nsTemplate string, gitEvent *github.RepositoryEvent) (string, error) {
+func generateNamespaceAndRepositoryName(nsTemplate, repoTemplate string, gitEvent *github.RepositoryEvent) (string, string, error) {
 	repoOwner, repoName, err := formatting.GetRepoOwnerSplitted(gitEvent.Repo.GetHTMLURL())
 	if err != nil {
-		return "", fmt.Errorf("failed to parse git repo url: %w", err)
+		return "", "", fmt.Errorf("failed to parse git repo url: %w", err)
+	}
+
+	nsName := ""
+	repoCRName := ""
+	placeholders := map[string]string{
+		"repo_owner": repoOwner,
+		"repo_name":  repoName,
 	}
 
 	if nsTemplate == "" {
-		return fmt.Sprintf(defaultNsTemplate, repoName), nil
+		nsName = fmt.Sprintf(defaultNsTemplate, repoName)
+	} else {
+		nsName = templates.ReplacePlaceHoldersVariables(nsTemplate, placeholders, nil, http.Header{}, map[string]any{})
 	}
 
-	maptemplate := map[string]string{
-		"repo_owner": repoOwner,
-		"repo_name":  repoName,
+	if repoTemplate == "" {
+		repoCRName = fmt.Sprintf(defaultRepoTemplate, repoName)
+	} else {
+		repoCRName = templates.ReplacePlaceHoldersVariables(repoTemplate, placeholders, nil, http.Header{}, map[string]any{})
 	}
-	return templates.ReplacePlaceHoldersVariables(nsTemplate, maptemplate, nil, http.Header{}, map[string]any{}), nil
+	return nsName, repoCRName, nil
 }
diff --git a/pkg/provider/github/repository_test.go b/pkg/provider/github/repository_test.go
