Skip to content

Release workflow

Callum Wright edited this page Feb 2, 2024 · 5 revisions

Draft a new GitHub Release

  1. Draft a new release
  2. Select 'Choose a tag', enter the desired tag and select 'Create new tag: <tag> on publish'
  3. Enter 'Release title' following the format Release <tag>
  4. Select 'Generate release notes'
  5. Select 'Save draft'

Note that binaries do not need to be uploaded.

Update package version

This requires the package.json to be updated manually. This should be automated through GitHub actions soon.

Update Changelog

This requires the CHANGELOG.md to be updated manually. The release notes can be used for reference.

Publish the Visual Studio Code Extension

  1. Open a console
  2. Enter the command vsce publish <tag-without-prefixed-v>

Publish GitHub Release

  1. Open Releases
  2. Select draft release
  3. Select 'Publish release'