Skip to content

Commit 31e5b2e

Browse files
committed
docs(copier): apply Dachary feedback to READMEs
1 parent 4395613 commit 31e5b2e

File tree

3 files changed

+11
-34
lines changed

3 files changed

+11
-34
lines changed

examples-copier/configs/copier-config-examples/MAIN-CONFIG-README.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,6 @@ See the example files in this directory:
250250

251251
### Component References
252252

253-
**Now Fully Supported!**
254-
255253
You can use `$ref` to reference external files for transformations, commit_strategy, and exclude patterns:
256254

257255
```yaml
@@ -308,13 +306,4 @@ For questions or issues:
308306
3. Validate your configuration syntax
309307
4. Test with `DRY_RUN=true`
310308

311-
## Future Enhancements
312-
313-
Planned features:
314-
315-
- ✅ ~~Full `$ref` support for all component types~~ **IMPLEMENTED!**
316-
- Config validation CLI tool
317-
- Config migration tool
318-
- Visual config editor
319-
- Config testing framework
320309

examples-copier/configs/copier-config-examples/QUICK-START-MAIN-CONFIG.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -248,14 +248,6 @@ workflows:
248248
- **Examples**: `main-config-example.yaml`, `source-repo-workflows-example.yaml`
249249
- **Reusable Components**: `reusable-components/` directory
250250

251-
## Key Benefits
252-
253-
**Separation of Concerns** - Each repo manages its own workflows
254-
**Scalability** - Works for monorepos with many workflows
255-
**Flexibility** - Mix centralized and distributed configs
256-
**Discoverability** - Configs live near source code
257-
**Maintainability** - Update workflows without touching main config
258-
259251
## Common Use Cases
260252

261253
### Use Case 1: Monorepo with Many Workflows
@@ -306,7 +298,4 @@ workflow_configs:
306298
path: ".copier/workflows.yaml"
307299
```
308300
309-
---
310-
311-
**Ready to get started?** Follow the steps above and you'll be up and running in minutes!
312-
301+
---

examples-copier/services/service_container.go

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ type ServiceContainer struct {
1414
FileStateService FileStateService
1515

1616
// New services
17-
ConfigLoader ConfigLoader
18-
PatternMatcher PatternMatcher
19-
PathTransformer PathTransformer
20-
MessageTemplater MessageTemplater
17+
ConfigLoader ConfigLoader
18+
PatternMatcher PatternMatcher
19+
PathTransformer PathTransformer
20+
MessageTemplater MessageTemplater
2121
PRTemplateFetcher PRTemplateFetcher
22-
AuditLogger AuditLogger
23-
MetricsCollector *MetricsCollector
24-
SlackNotifier SlackNotifier
22+
AuditLogger AuditLogger
23+
MetricsCollector *MetricsCollector
24+
SlackNotifier SlackNotifier
2525

2626
// Server state
27-
StartTime time.Time
27+
StartTime time.Time
2828
}
2929

3030
// NewServiceContainer creates and initializes all services
@@ -35,10 +35,10 @@ func NewServiceContainer(config *configs.Config) (*ServiceContainer, error) {
3535
// Initialize config loader based on configuration
3636
var configLoader ConfigLoader
3737
if config.UseMainConfig && config.MainConfigFile != "" {
38-
// Use main config loader for new format with workflow references
38+
// Use main config loader for new format with workflow references (when USE_MAIN_CONFIG=true)
3939
configLoader = NewMainConfigLoader()
4040
} else {
41-
// Use legacy config loader for backward compatibility
41+
// Use default config loader for singular config file (when USE_MAIN_CONFIG=false)
4242
configLoader = NewConfigLoader()
4343
}
4444

@@ -91,4 +91,3 @@ func (sc *ServiceContainer) Close(ctx context.Context) error {
9191
}
9292
return nil
9393
}
94-

0 commit comments

Comments
 (0)