Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 28, 2025

Addresses issue #[issue_number] by implementing a comprehensive solution to automatically sync the local CHANGELOG.md file with GitHub release notes, ensuring documentation stays current without manual intervention.

Problem

The local CHANGELOG.md file 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

  • File: .github/workflows/sync-release-notes.yml
  • Triggers: Automatically runs when releases are published or edited
  • Manual trigger: Can be executed on-demand via GitHub Actions
  • Security: Uses hardened runner and secure token handling
  • Smart commits: Only commits when changes are detected

🛠️ Local Sync Script

  • File: scripts/sync-changelog.js
  • Usage: npm run sync-changelog for live sync, npm run sync-changelog:test for testing
  • Authentication: Supports both GitHub CLI and API token methods
  • Fallback: Graceful degradation when authentication isn't available

🧠 Intelligent Processing

The script intelligently processes release data:

  • Preserves existing [Unreleased] section structure
  • Converts release notes to proper changelog bullet format
  • Distinguishes between pre-releases and regular releases
  • Removes GitHub-specific content (Full Changelog links)
  • Maintains chronological order (newest first)

📖 Enhanced Documentation

Updated README.md with comprehensive usage instructions including:

  • Manual sync commands
  • Automatic sync behavior explanation
  • Test mode usage
  • Authentication requirements

Example Transformation

Before:

## [0.0.1] - Initial Release
- Initial release
- Real-time token tracking with status bar display

After:

## [0.0.1] - Pre-release
- First rough version, not complete of course!
- Only tested on windows
- Use at your own risk 😄
- Screenshots in the README
- VS Code v1.104 or higher

Usage

  • Automatic: Workflow runs automatically on release events
  • Manual: npm run sync-changelog to sync anytime
  • Testing: npm run sync-changelog:test to test with sample data

This 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

This section details on the original issue you should resolve

<issue_title>[FEATURE] Extension release notes from GitHub Release Notes</issue_title>
<issue_description>Is your feature request related to a problem? Please describe.
The release notes in the hardcoded file always are lagging with the release notes from the GitHub release we generate. Setup a process to automatically update the release notes in the local file

Describe the solution you'd like
Easy and automated!

Priority
How important is this feature to you?

  • Critical - I can't use the extension effectively without this
  • High - This would significantly improve my experience
  • Medium - This would be a nice addition
  • Low - This is just a suggestion
    </issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #27

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 3 commits September 28, 2025 12:46
Co-authored-by: rajbos <6085745+rajbos@users.noreply.github.com>
- Add GitHub workflow to sync CHANGELOG.md with GitHub releases
- Add Node.js script for manual synchronization
- Support both GitHub CLI and API token authentication
- Include test mode for local development
- Add npm scripts for easy usage
- Update documentation with sync instructions

Co-authored-by: rajbos <6085745+rajbos@users.noreply.github.com>
Co-authored-by: rajbos <6085745+rajbos@users.noreply.github.com>
Copilot AI changed the title [WIP] [FEATURE] Extension release notes from GitHub Release Notes feat: add automated release notes synchronization from GitHub releases Sep 28, 2025
Copilot AI requested a review from rajbos September 28, 2025 12:54
Copilot finished work on behalf of rajbos September 28, 2025 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] Extension release notes from GitHub Release Notes

2 participants