Skip to content

Commit 22b9036

Browse files
committed
feat!: introduce template synchronization system with breaking changes
BREAKING CHANGE: This release introduces a new CI-driven template synchronization system that fundamentally changes how template updates are distributed. Repositories created from this template will now receive automatic updates through GitHub Actions workflows. This includes new required files (.template-marker, .template-version), a shared utilities architecture, and new configuration requirements. See BREAKING_CHANGES.md for migration details.
1 parent 96be432 commit 22b9036

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

BREAKING_CHANGES.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Breaking Changes in v2.0.0
2+
3+
This major version introduces several breaking changes:
4+
5+
## Template Synchronization System
6+
- Added automated CI-driven template synchronization
7+
- Repositories created from this template will now receive automatic updates
8+
- New required files: `.template-marker` and `.template-version`
9+
10+
## Shared Utilities Architecture
11+
- Introduced shared utilities in `shared/` directory
12+
- Changed fetch utility API and configuration
13+
- New dependency management system
14+
15+
## Configuration Changes
16+
- New template sync configuration in `.github/template-sync-config.yml`
17+
- Updated GitHub Actions workflows for template synchronization
18+
- Changed package structure to support shared components
19+
20+
## Migration Guide
21+
22+
To migrate from v1.x to v2.0:
23+
24+
1. Add `.template-marker` file to your repository
25+
2. Update your fetch utilities to use the new configurable fetch API
26+
3. Review and update any custom GitHub Actions workflows
27+
4. Ensure your repository is configured to receive template updates
28+
29+
For more details, see the documentation in the README.

0 commit comments

Comments
 (0)