refactor: rename env vars to clarify they're for config repo

- Renamed REPO_OWNER → CONFIG_REPO_OWNER
- Renamed REPO_NAME → CONFIG_REPO_NAME
- Renamed SRC_BRANCH → CONFIG_REPO_BRANCH

This makes it clear these variables are for the config repository
(where copier-config.yaml is stored), not for source code repos.

Updated:
- Config struct and constants in environment.go
- All service files that reference these variables
- All test files
- All config examples (.env.local.example, env.yaml.example, env.yaml.production)

Breaking change: Deployments must update their env.yaml files with new variable names.

Author: cbullinger

examples-copier/configs/.env.local.example

@@ -15,11 +15,12 @@
 # REQUIRED FOR LOCAL TESTING
 # ============================================================================
 
-# Source Repository Configuration (Required)
-REPO_NAME="<source-repo-name>"
-REPO_OWNER="<github-username-or-org>"
-# Source Branch (Optional - default: main)
-SRC_BRANCH="test"
+# Config Repository Configuration (Required)
+# This is where your copier-config.yaml file is stored
+CONFIG_REPO_NAME="<config-repo-name>"
+CONFIG_REPO_OWNER="<github-username-or-org>"
+# Config Branch (Optional - default: main)
+CONFIG_REPO_BRANCH="main"
 
 # Configuration Files
 CONFIG_FILE=copier-config.yaml

examples-copier/configs/env.yaml.example

@@ -5,9 +5,12 @@ env_variables:
 
   # GitHub App Configuration
   GITHUB_APP_ID: "YOUR_GITHUB_APP_ID"              # Your GitHub App ID (required)
-  INSTALLATION_ID: "YOUR_INSTALLATION_ID"          # GitHub App Installation ID (required)
-  REPO_OWNER: "your-org"                           # Source repository owner (required)
-  REPO_NAME: "your-repo"                           # Source repository name (required)
+  INSTALLATION_ID: "YOUR_INSTALLATION_ID"          # GitHub App Installation ID (optional - can auto-discover)
+
+  # Config Repository (where copier-config.yaml is stored)
+  CONFIG_REPO_OWNER: "your-org"                    # Config repository owner (required)
+  CONFIG_REPO_NAME: "your-config-repo"             # Config repository name (required)
+  CONFIG_REPO_BRANCH: "main"                       # Config file branch (default: main)
 
   # =============================================================================
   # SECRET MANAGER REFERENCES (RECOMMENDED - Most Secure)
@@ -42,12 +45,9 @@ env_variables:
   WEBSERVER_PATH: "/events"                        # Webhook endpoint path (default: /webhook)
 
   # Configuration Files
-  CONFIG_FILE: "copier-config.yaml"                # Config file name in source repo (default: copier-config.yaml)
+  CONFIG_FILE: "copier-config.yaml"                # Config file name in config repo (default: copier-config.yaml)
   DEPRECATION_FILE: "deprecated_examples.json"     # Deprecation tracking file (default: deprecated_examples.json)
 
-  # Source Branch
-  SRC_BRANCH: "main"                               # Branch to copy from (default: main)
-  
   # =============================================================================
   # COMMITTER INFORMATION
   # =============================================================================

examples-copier/configs/env.yaml.production

@@ -3,9 +3,11 @@
 # =============================================================================
 GITHUB_APP_ID: "1166559"
 INSTALLATION_ID: "62138132"
-REPO_OWNER: "mongodb"
-REPO_NAME: "docs-mongodb-internal"
-SRC_BRANCH: "main"
+
+# Config Repository (where copier-config.yaml is stored)
+CONFIG_REPO_OWNER: "mongodb"
+CONFIG_REPO_NAME: "docs-mongodb-internal"
+CONFIG_REPO_BRANCH: "main"
 
 # =============================================================================
 # Secret Manager References (Sensitive Data - SECURE!)

examples-copier/configs/environment.go

@@ -12,8 +12,8 @@ import (
 type Config struct {
 	EnvFile              string
 	Port                 string
-	RepoName             string
-	RepoOwner            string
+	ConfigRepoName       string // Repository where config file is stored
+	ConfigRepoOwner      string // Owner of repository where config file is stored
 	AppId                string
 	AppClientId          string
 	InstallationId       string
@@ -22,7 +22,7 @@ type Config struct {
 	ConfigFile           string
 	DeprecationFile      string
 	WebserverPath        string
-	SrcBranch            string
+	ConfigRepoBranch     string // Branch to fetch config file from
 	PEMKeyName           string
 	WebhookSecretName    string
 	WebhookSecret        string
@@ -60,8 +60,8 @@ type Config struct {
 const (
 	EnvFile              = "ENV"
 	Port                 = "PORT"
-	RepoName             = "REPO_NAME"
-	RepoOwner            = "REPO_OWNER"
+	ConfigRepoName       = "CONFIG_REPO_NAME"
+	ConfigRepoOwner      = "CONFIG_REPO_OWNER"
 	AppId                = "GITHUB_APP_ID"
 	AppClientId          = "GITHUB_APP_CLIENT_ID"
 	InstallationId       = "INSTALLATION_ID"
@@ -70,7 +70,7 @@ const (
 	ConfigFile           = "CONFIG_FILE"
 	DeprecationFile      = "DEPRECATION_FILE"
 	WebserverPath        = "WEBSERVER_PATH"
-	SrcBranch            = "SRC_BRANCH"
+	ConfigRepoBranch     = "CONFIG_REPO_BRANCH"
 	PEMKeyName           = "PEM_NAME"
 	WebhookSecretName    = "WEBHOOK_SECRET_NAME"
 	WebhookSecret        = "WEBHOOK_SECRET"
@@ -106,7 +106,7 @@ func NewConfig() *Config {
 		ConfigFile:           "copier-config.yaml",
 		DeprecationFile:      "deprecated_examples.json",
 		WebserverPath:        "/webhook",
-		SrcBranch:            "main",                                                           // Default branch to copy from (NOTE: we are purposefully only allowing copying from `main` branch right now)
+		ConfigRepoBranch:     "main",                                                           // Default branch to fetch config file from
 		PEMKeyName:           "projects/1054147886816/secrets/CODE_COPIER_PEM/versions/latest", // default secret name for GCP Secret Manager
 		WebhookSecretName:    "projects/1054147886816/secrets/webhook-secret/versions/latest",  // default webhook secret name for GCP Secret Manager
 		CopierLogName:        "copy-copier-log",                                                // default log name for logging to GCP
@@ -152,8 +152,8 @@ func LoadEnvironment(envFile string) (*Config, error) {
 
 	// Populate config from environment variables, with defaults where applicable
 	config.Port = getEnvWithDefault(Port, config.Port)
-	config.RepoName = os.Getenv(RepoName)
-	config.RepoOwner = os.Getenv(RepoOwner)
+	config.ConfigRepoName = os.Getenv(ConfigRepoName)
+	config.ConfigRepoOwner = os.Getenv(ConfigRepoOwner)
 	config.AppId = os.Getenv(AppId)
 	config.AppClientId = os.Getenv(AppClientId)
 	config.InstallationId = os.Getenv(InstallationId)
@@ -162,7 +162,7 @@ func LoadEnvironment(envFile string) (*Config, error) {
 	config.ConfigFile = getEnvWithDefault(ConfigFile, config.ConfigFile)
 	config.DeprecationFile = getEnvWithDefault(DeprecationFile, config.DeprecationFile)
 	config.WebserverPath = getEnvWithDefault(WebserverPath, config.WebserverPath)
-	config.SrcBranch = getEnvWithDefault(SrcBranch, config.SrcBranch)
+	config.ConfigRepoBranch = getEnvWithDefault(ConfigRepoBranch, config.ConfigRepoBranch)
 	config.PEMKeyName = getEnvWithDefault(PEMKeyName, config.PEMKeyName)
 	config.WebhookSecretName = getEnvWithDefault(WebhookSecretName, config.WebhookSecretName)
 	config.WebhookSecret = os.Getenv(WebhookSecret)
@@ -199,8 +199,8 @@ func LoadEnvironment(envFile string) (*Config, error) {
 
 	// Export resolved values back into environment so downstream os.Getenv sees defaults
 	_ = os.Setenv(Port, config.Port)
-	_ = os.Setenv(RepoName, config.RepoName)
-	_ = os.Setenv(RepoOwner, config.RepoOwner)
+	_ = os.Setenv(ConfigRepoName, config.ConfigRepoName)
+	_ = os.Setenv(ConfigRepoOwner, config.ConfigRepoOwner)
 	_ = os.Setenv(AppId, config.AppId)
 	_ = os.Setenv(AppClientId, config.AppClientId)
 	_ = os.Setenv(InstallationId, config.InstallationId)
@@ -209,7 +209,7 @@ func LoadEnvironment(envFile string) (*Config, error) {
 	_ = os.Setenv(ConfigFile, config.ConfigFile)
 	_ = os.Setenv(DeprecationFile, config.DeprecationFile)
 	_ = os.Setenv(WebserverPath, config.WebserverPath)
-	_ = os.Setenv(SrcBranch, config.SrcBranch)
+	_ = os.Setenv(ConfigRepoBranch, config.ConfigRepoBranch)
 	_ = os.Setenv(PEMKeyName, config.PEMKeyName)
 	_ = os.Setenv(CopierLogName, config.CopierLogName)
 	_ = os.Setenv(GoogleCloudProjectId, config.GoogleCloudProjectId)
@@ -260,10 +260,10 @@ func validateConfig(config *Config) error {
 	var missingVars []string
 
 	requiredVars := map[string]string{
-		RepoName:       config.RepoName,
-		RepoOwner:      config.RepoOwner,
-		AppId:          config.AppId,
-		InstallationId: config.InstallationId,
+		ConfigRepoName:  config.ConfigRepoName,
+		ConfigRepoOwner: config.ConfigRepoOwner,
+		AppId:           config.AppId,
+		InstallationId:  config.InstallationId,
 	}
 
 	for name, value := range requiredVars {

examples-copier/services/config_loader.go

@@ -81,11 +81,11 @@ func retrieveConfigFileContent(ctx context.Context, filePath string, config *con
 	// Fetch file content
 	fileContent, _, _, err := client.Repositories.GetContents(
 		ctx,
-		config.RepoOwner,
-		config.RepoName,
+		config.ConfigRepoOwner,
+		config.ConfigRepoName,
 		filePath,
 		&github.RepositoryContentGetOptions{
-			Ref: config.SrcBranch,
+			Ref: config.ConfigRepoBranch,
 		},
 	)
 	if err != nil {

examples-copier/services/github_read.go

@@ -22,8 +22,8 @@ func GetFilesChangedInPr(pr_number int) ([]ChangedFile, error) {
 
 	var prQuery PullRequestQuery
 	variables := map[string]interface{}{
-		"owner":  githubv4.String(os.Getenv(configs.RepoOwner)),
-		"name":   githubv4.String(os.Getenv(configs.RepoName)),
+		"owner":  githubv4.String(os.Getenv(configs.ConfigRepoOwner)),
+		"name":   githubv4.String(os.Getenv(configs.ConfigRepoName)),
 		"number": githubv4.Int(pr_number),
 	}
 
@@ -72,18 +72,18 @@ func GetFilesChangedInPr(pr_number int) ([]ChangedFile, error) {
 	return changedFiles, nil
 }
 
-// RetrieveFileContents fetches the contents of a file from the repository at the specified path.
+// RetrieveFileContents fetches the contents of a file from the config repository at the specified path.
 // It returns a github.RepositoryContent object containing the file details.
 func RetrieveFileContents(filePath string) (github.RepositoryContent, error) {
-	owner := os.Getenv(configs.RepoOwner)
-	repo := os.Getenv(configs.RepoName)
+	owner := os.Getenv(configs.ConfigRepoOwner)
+	repo := os.Getenv(configs.ConfigRepoName)
 	client := GetRestClient()
 	ctx := context.Background()
 
 	fileContent, _, _, err :=
 		client.Repositories.GetContents(ctx, owner, repo,
 			filePath, &github.RepositoryContentGetOptions{
-				Ref: os.Getenv(configs.SrcBranch),
+				Ref: os.Getenv(configs.ConfigRepoBranch),
 			})
 
 	if err != nil {

examples-copier/services/github_write_to_source.go

@@ -25,11 +25,11 @@ func UpdateDeprecationFile() {
 
 	fileContent, _, _, err := client.Repositories.GetContents(
 		ctx,
-		os.Getenv(configs.RepoOwner),
-		os.Getenv(configs.RepoName),
+		os.Getenv(configs.ConfigRepoOwner),
+		os.Getenv(configs.ConfigRepoName),
 		os.Getenv(configs.DeprecationFile),
 		&github.RepositoryContentGetOptions{
-			Ref: os.Getenv(configs.SrcBranch),
+			Ref: os.Getenv(configs.ConfigRepoBranch),
 		},
 	)
 	if err != nil {
@@ -75,8 +75,8 @@ func uploadDeprecationFileChanges(message string, newDeprecationFileContents str
 	client := GetRestClient()
 	ctx := context.Background()
 
-	targetFileContent, _, _, err := client.Repositories.GetContents(ctx, os.Getenv(configs.RepoOwner), os.Getenv(configs.RepoName),
-		os.Getenv(configs.DeprecationFile), &github.RepositoryContentGetOptions{Ref: os.Getenv(configs.SrcBranch)})
+	targetFileContent, _, _, err := client.Repositories.GetContents(ctx, os.Getenv(configs.ConfigRepoOwner), os.Getenv(configs.ConfigRepoName),
+		os.Getenv(configs.DeprecationFile), &github.RepositoryContentGetOptions{Ref: os.Getenv(configs.ConfigRepoBranch)})
 
 	if err != nil {
 		LogError(fmt.Sprintf("Error getting deprecation file contents: %v", err))
@@ -85,13 +85,13 @@ func uploadDeprecationFileChanges(message string, newDeprecationFileContents str
 	options := &github.RepositoryContentFileOptions{
 		Message: github.String(message),
 		Content: []byte(newDeprecationFileContents),
-		Branch:  github.String(os.Getenv(configs.SrcBranch)),
+		Branch:  github.String(os.Getenv(configs.ConfigRepoBranch)),
 		Committer: &github.CommitAuthor{Name: github.String(os.Getenv(configs.CommitterName)),
 			Email: github.String(os.Getenv(configs.CommitterEmail))},
 	}
 
 	options.SHA = targetFileContent.SHA
-	_, _, err = client.Repositories.UpdateFile(ctx, os.Getenv(configs.RepoOwner), os.Getenv(configs.RepoName), os.Getenv(configs.DeprecationFile), options)
+	_, _, err = client.Repositories.UpdateFile(ctx, os.Getenv(configs.ConfigRepoOwner), os.Getenv(configs.ConfigRepoName), os.Getenv(configs.DeprecationFile), options)
 	if err != nil {
 		LogError(fmt.Sprintf("Cannot update deprecation file: %v", err))
 	}

examples-copier/services/github_write_to_target.go

@@ -24,8 +24,8 @@ var FilesToDeprecate map[string]Configs
 
 
 
-// repoOwner returns the repository owner from environment variables.
-func repoOwner() string { return os.Getenv(configs.RepoOwner) }
+// repoOwner returns the config repository owner from environment variables.
+func repoOwner() string { return os.Getenv(configs.ConfigRepoOwner) }
 
 // parseRepoPath parses a repository path in the format "owner/repo" and returns owner and repo separately.
 // If the path doesn't contain a slash, it returns the source repo owner from env and the path as repo name.

examples-copier/services/github_write_to_target_test.go

@@ -27,13 +27,13 @@ import (
 
 func TestMain(m *testing.M) {
 	// Minimal env so init() and any env readers are happy.
-	os.Setenv(configs.RepoOwner, "my-org")
-	os.Setenv(configs.RepoName, "target-repo")
+	os.Setenv(configs.ConfigRepoOwner, "my-org")
+	os.Setenv(configs.ConfigRepoName, "config-repo")
 	os.Setenv(configs.InstallationId, "12345")
 	os.Setenv(configs.AppId, "1166559")
 	os.Setenv(configs.AppClientId, "IvTestClientId")
 	os.Setenv("SKIP_SECRET_MANAGER", "true")
-	os.Setenv("SRC_BRANCH", "main")
+	os.Setenv(configs.ConfigRepoBranch, "main")
 
 	// Provide an RSA private key (both raw and b64) so ConfigurePermissions can parse.
 	key, _ := rsa.GenerateKey(rand.Reader, 1024)
@@ -45,8 +45,8 @@ func TestMain(m *testing.M) {
 	code := m.Run()
 
 	// Cleanup
-	os.Unsetenv(configs.RepoOwner)
-	os.Unsetenv(configs.RepoName)
+	os.Unsetenv(configs.ConfigRepoOwner)
+	os.Unsetenv(configs.ConfigRepoName)
 	os.Unsetenv(configs.InstallationId)
 	os.Unsetenv(configs.AppId)
 	os.Unsetenv(configs.AppClientId)