Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.27 KB

RELEASING.md

File metadata and controls

37 lines (24 loc) · 1.27 KB
Raw

Overall process

Core

  1. Generate changelog
  2. Update docs/upgrading.md for major/minor releases
  3. Create a new release branch for major/minor releases, eg 0-15-0, off main. Patch releases use existing release branches.
  4. Create Github release with name and tag matching v[version] on the appropriate release branch.
  5. Copy/paste changelog from generated output into Github release notes
  6. GH automation should take it from there and build/upload artifacts
  7. Update default branch on netlify to new release branch (new release branch only)

Changelog generation

./scripts/changelog.sh [previous version] [next version] [branch]

This script requires docker running and GITHUB_TOKEN set with a PAT.

The changelog will be written to changelog.md

Major/minor release example

GITHUB_TOKEN=XXXXXX ./changelog.sh v0.14.0 v0.15.0 main changelog.md

Patch release example

GITHUB_TOKEN=XXXXXX ./changelog.sh v0.14.6 v0.14.7 main changelog.md

Release branches

For each major or minor release, we create a release branch [major]-[minor]-0. This is to allow feature freeze ahead of actual release and provide a stable branch to apply patches onto for bug fixes.

These branches are to be protected and may receive updates via backport or direct PR.