feat: add automated release notes synchronization from GitHub releases #28
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses issue #[issue_number] by implementing a comprehensive solution to automatically sync the local
CHANGELOG.mdfile with GitHub release notes, ensuring documentation stays current without manual intervention.Problem
The local
CHANGELOG.mdfile contained minimal, hardcoded release notes that quickly became outdated compared to the rich, detailed release notes published in GitHub releases. This created inconsistency between local documentation and published releases.Solution
This PR introduces both automated and manual synchronization capabilities:
🤖 Automated GitHub Workflow
.github/workflows/sync-release-notes.yml🛠️ Local Sync Script
scripts/sync-changelog.jsnpm run sync-changelogfor live sync,npm run sync-changelog:testfor testing🧠 Intelligent Processing
The script intelligently processes release data:
[Unreleased]section structure📖 Enhanced Documentation
Updated
README.mdwith comprehensive usage instructions including:Example Transformation
Before:
After:
Usage
npm run sync-changelogto sync anytimenpm run sync-changelog:testto test with sample dataThis ensures the local changelog never lags behind GitHub releases, providing users with consistent and up-to-date release information across all documentation sources.
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.