Skip to content

RELEASE.md

Latest commit

 

History

History
61 lines (41 loc) · 1.24 KB

RELEASE.md

File metadata and controls

61 lines (41 loc) · 1.24 KB

Release Guide

Steps to Release a New Version

  1. Update CHANGELOG.md:

    • Add version entry: ## [X.Y.Z] - YYYY-MM-DD with changes

  2. Update version in package.json:

    # Edit package.json to set "version": "X.Y.Z"
npm install  # sync package-lock.json

  3. Verify packaging locally:

    npm run package

    Confirm the .vsix file is generated without errors. You may keep it for manual testing.

  4. Commit and push:

    git add CHANGELOG.md package.json
git commit -m "chore: update version to vX.Y.Z"
git push origin main

  5. Run the release workflow:

    gh workflow run release.yml

    This runs tests, packages the extension as .vsix, and creates a GitHub Release with the file attached.

    To overwrite an existing release for the same version:

    gh workflow run release.yml -f overwrite=true

  6. Verify the release:

    gh release view vX.Y.Z

  1. Update the release notes on GitHub to match CHANGELOG.md:

    gh release edit vX.Y.Z --notes "## What's Changed
- Change 1
- Change 2

**Full Changelog**: https://github.com/euxx/github-copilot-usage/compare/vPREV...vX.Y.Z"