Skip to content

RELEASING.md

Latest commit

 

History

History
49 lines (29 loc) · 1.71 KB

RELEASING.md

File metadata and controls

49 lines (29 loc) · 1.71 KB
Raw

Releasing a new version

Blueprint no longer maintains CHANGELOG.md for new releases. Release notes are generated by GitHub from merged pull requests and commits.

Prepare the release

  1. Choose the next semantic version tag, using the existing bare version format, for example 6.8.0.

  2. Make sure all release-bound changes are merged to main.

  3. Confirm the latest main branch build is passing in GitHub Actions.

  4. Do not add entries to CHANGELOG.md. The file is retained only for historical release notes.

Cut the release

The release script creates a draft GitHub release for the requested version and asks GitHub to generate the release notes.

git checkout main
git pull --ff-only origin main
Scripts/release.sh --version 6.8.0

By default, the script targets origin/main and creates a draft release. Review the generated release notes in GitHub, make any necessary edits, then publish the release. If you intentionally want to skip the draft review step, pass --publish.

To target a specific merge commit instead of origin/main, pass its full SHA:

Scripts/release.sh --version 6.8.0 --target 0123456789abcdef0123456789abcdef01234567

Manual fallback

  1. Go to Releases and choose Draft a new release.

  2. Choose or create the tag for the new version. Target the latest main commit that should be included in the release.

  3. Use GitHub's generated release notes.

  4. Set the release title to the version number, review the generated notes, and publish the release.

After publishing

Fetch tags locally if you need the new release tag in your checkout:

git fetch --tags origin