Skip to content

RELEASE.md

Latest commit

 

History

History
17 lines (14 loc) · 1.67 KB

RELEASE.md

File metadata and controls

17 lines (14 loc) · 1.67 KB
Raw

How to release

  1. Dev bumps version in package.json.
  2. Dev updates CHANGELOG.md for the new version (in-repo human history). GitHub Release notes are also auto-generated from PR labels (see step 3) — keep both in mind; labels alone do not update CHANGELOG.md.
  3. Dev creates a release/xyz (or hotfix/xyz) branch and pushes it (never target develop nor master). This single push triggers GitHub Actions to:
    • Create a draft release tagged vX.Y.Z (read from package.json) with auto-generated notes — see .github/workflows/release.yml. Notes are categorized via .github/release.yml by PR label, so labelling merged PRs keeps the GitHub release notes tidy.
    • Build all binaries (macOS / Windows / Linux), which electron-builder attaches to the draft.
    • E.g. if the version is 1.0.0, the tag is v1.0.0.
    • The draft step is idempotent: if a release for that tag already exists it is left untouched, so re-pushing the branch will not clobber a signed draft.
  4. Ensure that .yml files aren't being left out in the artifacts. These are needed for auto-update to work correctly.
  5. Once all binaries have been uploaded to the draft, Dev messages THORCHAIN-ADMIN and they sign and update the draft.
  6. Once they are done, publish the release. GitHub will tag the latest commit for you.

Links