Skip to content

RELEASING.md

Latest commit

 

History

History
50 lines (35 loc) · 2.97 KB

RELEASING.md

File metadata and controls

50 lines (35 loc) · 2.97 KB

Releasing

This document describes how to make a release using GitHub Actions.

There are two parts to making a release:

If you're making a major or minor release it is recommended to discuss it with the other contributors upfront (e.g. on Discord).

Prepare the release

Anyone with permission to push to the main branch can prepare a release.

  1. Add new information to CHANGELOG.md. Ideally the CHANGELOG.md should be up-to-date, but sometimes there will be accidental omissions when merging PRs.
    • Use git log --format=format:"* %s (%an)" --reverse <last-version-tag>..HEAD to list all commits since the last release.
    • Add changelog details under the # [vNext] heading; the release process will update this heading when it makes the release
  2. Check & update contributors list (if applicable)
    • List recent contributors: 
      git log --format=format:"%an <%ae>" --reverse <last-version-tag>..HEAD  | grep -vEi "(renovate|dependabot|Snyk)" | sort| uniq -i
    • Update contributors if necessary at the Contributors of this release part of the # [vNext] heading
  3. The Visual Studio extension releases are versioned sequentially within a year, with the format YYYY.SEQ.BUILD (e.g. 2024.5.182). In the beginning of the year, the year number must be updated and the sequence number has to be reset to 1. When preparing the release you just need to double-check if the version is correct. You can find the current version number in the Directory.Build.props file.

Make the release

Only people in group release-managers can make releases and only from the main branch.

Making a preview release

Making preview releases are currently not supported, but each build contains a deploy target with the vsix installation file included. Installing those could be used to test preview versions.

Making a production release

Production releases (or just releases) are intended to use for any users. Their version number does not contain a version suffix.

To release such a preview release, the following steps has to be done:

  1. Open the CI workflow at GitHub: https://github.com/reqnroll/Reqnroll.VisualStudio/actions/workflows/ci.yml
  2. Choose the "Run workflow" button to trigger the release with the following settings:
    • deploy_packages: checked
    • is_production_release: checked
    • custom_version_suffix: leave it empty
    • custom_configuration: leave it on default
  3. The CI workflow runs and ideally passes all core and testing jobs, but will stop for approval before running the release job.
  4. Make sure everything is OK. You can even download the packages to be published for a smoke test if necessary.
  5. If everything is fine, approve the deployment job.
  6. The job will publish the packages, tag the current commit and create a new commit with the updated version number and changelog header.