|
| 1 | +--- |
| 2 | +description: Sync changelog updates from chakra-ui/zag repo to all Ark UI framework changelogs |
| 3 | +--- |
| 4 | + |
| 5 | +## Steps |
| 6 | + |
| 7 | +1. Fetch the latest CHANGELOG.md from the chakra-ui/zag repository |
| 8 | + - Use GitHub API or web fetch to get the changelog content |
| 9 | + - Focus on the `## Unreleased` section |
| 10 | + |
| 11 | +2. Parse the unreleased changes from Zag.js changelog |
| 12 | + - Extract all entries under `## Unreleased` |
| 13 | + - Identify component-specific changes and general improvements |
| 14 | + - Filter out any Zag.js internal changes that don't affect Ark UI |
| 15 | + |
| 16 | +3. Review the changes with me before applying |
| 17 | + - Show me the extracted changes |
| 18 | + - Confirm which changes should be synced to Ark UI |
| 19 | + - Ask if any changes need framework-specific notes |
| 20 | + |
| 21 | +4. Update all framework changelogs in the `## [Unreleased]` section |
| 22 | + - `@/packages/react/CHANGELOG.md` |
| 23 | + - `@/packages/solid/CHANGELOG.md` |
| 24 | + - `@/packages/svelte/CHANGELOG.md` |
| 25 | + - `@/packages/vue/CHANGELOG.md` |
| 26 | + |
| 27 | +5. Format the entries consistently |
| 28 | + - Follow existing changelog format (component name in bold, description) |
| 29 | + - Maintain consistent categorization: Added, Fixed, Changed, etc. |
| 30 | + - Preserve code examples if they exist in the Zag changelog |
| 31 | + |
| 32 | +6. Show me a summary of all changes made |
| 33 | + - List which components were updated |
| 34 | + - Highlight any differences between frameworks (if applicable) |
| 35 | + |
| 36 | +## Important Notes |
| 37 | + |
| 38 | +- Only sync changes that are relevant to Ark UI components |
| 39 | +- Skip Zag.js internal changes (build system, documentation-only, etc.) |
| 40 | +- Ensure the changelog format matches the existing style in each file |
| 41 | +- Don't modify any sections other than `## [Unreleased]` |
| 42 | +- If `## [Unreleased]` is empty in the framework changelogs, add the changes there |
| 43 | +- If it already has content, prepend the new changes |
0 commit comments