Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

Commit c62d3e4

Browse files
committed
docs(copier): remove legacy rules references from example configs
1 parent 6bb4fdf commit c62d3e4

File tree

7 files changed

+2
-90
lines changed

7 files changed

+2
-90
lines changed

examples-copier/configs/copier-config-examples/copier-config-workflow.yaml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -171,16 +171,6 @@ workflows:
171171
This PR includes all synchronized files from the source repository.
172172
auto_merge: false
173173

174-
# ============================================================================
175-
# BENEFITS OF THIS FORMAT
176-
# ============================================================================
177-
#
178-
# 1. SIMPLER: 3 workflows instead of 12 rules (70% reduction)
179-
# 2. CLEARER: Each workflow shows complete source → destination mapping
180-
# 3. MULTI-ORG READY: Each workflow can have different source repo
181-
# 4. EASIER TO MAINTAIN: Add new apps by adding one workflow
182-
# 5. BETTER DEFAULTS: Global defaults reduce repetition
183-
#
184174
# ============================================================================
185175
# ADDING A NEW APP
186176
# ============================================================================

examples-copier/configs/copier-config-examples/main-config-example.yaml

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -137,35 +137,6 @@ workflow_configs:
137137
# - Handles authentication automatically
138138
#
139139
# ============================================================================
140-
# BENEFITS OF THIS APPROACH
141-
# ============================================================================
142-
#
143-
# 1. SEPARATION OF CONCERNS
144-
# - Each source repo manages its own workflows
145-
# - Central config provides global defaults and references
146-
# - Clear ownership and responsibility
147-
#
148-
# 2. SCALABILITY
149-
# - Works well for monorepos with many workflows
150-
# - Each workflow config can be split into multiple files
151-
# - Easy to add new source repos
152-
#
153-
# 3. FLEXIBILITY
154-
# - Supports both centralized and distributed configurations
155-
# - Can mix local, repo, and inline references
156-
# - Easy to migrate from legacy format
157-
#
158-
# 4. DISCOVERABILITY
159-
# - Workflow configs live near the source code
160-
# - Easy to find and understand
161-
# - Version controlled with source code
162-
#
163-
# 5. MAINTAINABILITY
164-
# - Update workflows without touching main config
165-
# - Test workflow configs independently
166-
# - Clear separation between global and local settings
167-
#
168-
# ============================================================================
169140
# ENVIRONMENT VARIABLES
170141
# ============================================================================
171142
#

examples-copier/configs/copier-config-examples/multi-org-config-example.yaml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -298,16 +298,4 @@ workflows:
298298
# - move: { from: "src", to: "dest" }
299299
#
300300
# ============================================================================
301-
# BENEFITS
302-
# ============================================================================
303-
#
304-
# ✅ Multiple source repos (unlimited orgs)
305-
# ✅ Multiple destination repos (unlimited orgs)
306-
# ✅ Cross-org copying (10gen → mongodb)
307-
# ✅ Auto-discovery of installation IDs
308-
# ✅ Centralized config (single source of truth)
309-
# ✅ Simple workflow syntax (70% less config)
310-
# ✅ Easy to add new orgs (just add workflows)
311-
#
312-
# ============================================================================
313301

examples-copier/configs/copier-config-examples/source-repo-workflows-example.yaml

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -154,36 +154,6 @@ workflows:
154154
- README and .gitignore
155155
auto_merge: false
156156

157-
# ============================================================================
158-
# BENEFITS OF THIS STRUCTURE
159-
# ============================================================================
160-
#
161-
# 1. CO-LOCATION
162-
# - Workflow config lives with source code
163-
# - Easy to find and update
164-
# - Version controlled with source
165-
#
166-
# 2. OWNERSHIP
167-
# - Source repo team owns the workflow config
168-
# - Can update without touching central config
169-
# - Clear responsibility
170-
#
171-
# 3. TESTING
172-
# - Can test workflow config changes in source repo
173-
# - PR reviews include workflow changes
174-
# - Easy to validate before merging
175-
#
176-
# 4. SCALABILITY
177-
# - Each source repo has its own config
178-
# - No central bottleneck
179-
# - Easy to add new workflows
180-
#
181-
# 5. AUTOMATIC CONTEXT INFERENCE
182-
# - No need to specify source.repo and source.branch in workflows
183-
# - Automatically inherited from the workflow config reference
184-
# - Less redundancy, cleaner configuration
185-
# - Can still override if needed (e.g., different branch)
186-
#
187157
# ============================================================================
188158
# SOURCE CONTEXT INFERENCE
189159
# ============================================================================

examples-copier/configs/env.yaml.example

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ env_variables:
55

66
# GitHub App Configuration
77
GITHUB_APP_ID: "YOUR_GITHUB_APP_ID" # Your GitHub App ID (required)
8-
# INSTALLATION_ID is optional - used as fallback for legacy code
9-
# The app auto-discovers installation IDs per org using GetRestClientForOrg()
10-
# You can set this to any org's installation ID or leave it blank
11-
INSTALLATION_ID: "YOUR_INSTALLATION_ID" # GitHub App Installation ID (optional - auto-discovered per org)
128

139
# Config Repository (where copier-config.yaml is stored)
1410
CONFIG_REPO_OWNER: "your-org" # Config repository owner (required)

examples-copier/configs/env.yaml.production

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
# GitHub Configuration (Non-sensitive)
33
# =============================================================================
44
GITHUB_APP_ID: "1166559"
5-
# INSTALLATION_ID is optional - used as fallback for legacy code
6-
# The app auto-discovers installation IDs per org using GetRestClientForOrg()
7-
INSTALLATION_ID: "62138132" # MongoDB
85

96
# Config Repository (where copier-config.yaml is stored)
107
CONFIG_REPO_OWNER: "mongodb"

examples-copier/services/github_read.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ import (
1515
// GetFilesChangedInPr retrieves the list of files changed in a specified pull request.
1616
// It returns a slice of ChangedFile structures containing details about each changed file.
1717
// Parameters:
18-
// - owner: The repository owner (e.g., "cbullinger")
19-
// - repo: The repository name (e.g., "aggregation-tasks")
18+
// - owner: The repository owner (e.g., "mongodb")
19+
// - repo: The repository name (e.g., "docs-sample-apps")
2020
// - pr_number: The pull request number
2121
func GetFilesChangedInPr(owner string, repo string, pr_number int) ([]ChangedFile, error) {
2222
if InstallationAccessToken == "" {

0 commit comments

Comments
 (0)