Skip to content

RELEASE.md

Latest commit

 

History

History
36 lines (30 loc) · 1.64 KB

RELEASE.md

File metadata and controls

36 lines (30 loc) · 1.64 KB

Cutting a Jaeger UI release

  1. Prepare the release.

    • Go to jaeger-ui repository root directory, main branch.
    • Run git status && git pull to ensure the working directory is clean.
    • Run make prepare-release VERSION=vX.Y.Z.
    • This command will:
      • Verify the version format.
      • Create a branch release-vX.Y.Z.
      • Generate release notes and update CHANGELOG.md.
      • Update packages/jaeger-ui/package.json.
      • creating a PR with changelog:skip label and title "Prepare release vX.Y.Z".
    • Review the PR:
      • Check CHANGELOG.md content.
      • Verify package.json version.
      • Merge the PR once approved.

  2. Create a GitHub release.

    • Run make draft-release (requires gh)
      • It will create a draft release with the release notes.
      • Open the printed URL and hit the Edit button on the draft release.
      • Review the release notes and edit them if needed.
      • Publish the release.
      • Wait for the Publish release workflow to finish. It will generate release artifacts whi will be used by the main repository for the new UI.

Manual release

  • Manual:
    • The tag and release must refer to the commit created when the PR from the previous step was merged.
    • The tag name for the GitHub release should be the version for the release. It should include the "v", e.g. v1.0.0.
    • The title of the release match the format "Jaeger UI vX.Y.Z".
    • Copy the new CHANGELOG.md section into the release notes.