Parent Issue
#133 - Epic: Architecture Improvements for Muster
Objective
Address small, low-risk improvements that can be completed quickly.
Tasks
1. Add Missing doc.go Files
Some packages lack doc.go files. Add documentation for:
2. Split Files Exceeding 400 Lines
Per workspace rules, files should be under 400 lines. Current violations:
| File |
Lines |
Action |
internal/aggregator/server.go |
1146 |
Covered by #133.2 |
internal/client/filesystem_client.go |
1150 |
Split by domain |
internal/client/kubernetes_client.go |
500 |
Split by domain |
internal/workflow/executor.go |
931 |
Extract helpers |
3. Remove Deprecated Functions
Remove backward-compatibility aliases:
4. Consolidate Test Utilities
Move scattered test helpers to internal/testing/:
5. Update Import Organization
Ensure consistent import grouping:
- Standard library
- External dependencies
- Internal packages
Run goimports -w . across codebase.
Files to Create
internal/template/doc.go
- Any other missing
doc.go files
Files to Modify
internal/client/filesystem_client.go (split)
internal/client/kubernetes_client.go (split)
internal/workflow/executor.go (split)
internal/api/config.go (remove aliases)
- Various test files (consolidate mocks)
Acceptance Criteria
Dependencies
Should be done early - low risk and sets foundation.
Risks
Low - these are mechanical changes.
Estimated Effort
Small (1-2 days)
Parent Issue
#133 - Epic: Architecture Improvements for Muster
Objective
Address small, low-risk improvements that can be completed quickly.
Tasks
1. Add Missing
doc.goFilesSome packages lack
doc.gofiles. Add documentation for:internal/template/doc.gointernal/dependency/doc.go(verify exists)2. Split Files Exceeding 400 Lines
Per workspace rules, files should be under 400 lines. Current violations:
internal/aggregator/server.gointernal/client/filesystem_client.gointernal/client/kubernetes_client.gointernal/workflow/executor.go3. Remove Deprecated Functions
Remove backward-compatibility aliases:
api.RegisterConfig()→ useRegisterConfigHandler()api.GetConfig()→ useGetConfigHandler()4. Consolidate Test Utilities
Move scattered test helpers to
internal/testing/:internal/testing/mock/5. Update Import Organization
Ensure consistent import grouping:
Run
goimports -w .across codebase.Files to Create
internal/template/doc.godoc.gofilesFiles to Modify
internal/client/filesystem_client.go(split)internal/client/kubernetes_client.go(split)internal/workflow/executor.go(split)internal/api/config.go(remove aliases)Acceptance Criteria
doc.gofilesDependencies
Should be done early - low risk and sets foundation.
Risks
Low - these are mechanical changes.
Estimated Effort
Small (1-2 days)