Skip to content

Latest commit

 

History

History
85 lines (73 loc) · 6.2 KB

RELEASE.md

File metadata and controls

85 lines (73 loc) · 6.2 KB
Raw

Jaeger Overall Release Process

  1. Determine new version numbers for v1.x.x and v2.x.x
  2. Perform UI release according to https://github.com/jaegertracing/jaeger-ui/blob/main/RELEASE.md
  3. Perform Backend release (see below)
  4. Publish documentation for the new version on jaegertracing.io.
    1. Check that jaegertracing.io redirects to the new documentation release version URL.
    2. For monitoring and troubleshooting, refer to the jaegertracing/documentation Github Actions tab.
  5. Announce the release on the mailing list, slack, and twitter.

Jaeger Backend Release Process

  1. Create a PR "Prepare release 1.x.x / 2.x.x" against main or maintenance branch (example) by updating CHANGELOG.md to include:
    • A new section with the header 1.x.x / 2.x.x (YYYY-MM-DD) (copy the template at the top)
    • A curated list of notable changes and links to PRs. Do not simply dump git log, select the changes that affect the users. To obtain the list of all changes run make changelog.
    • The section can be split into sub-section if necessary, e.g. UI Changes, Backend Changes, Bug Fixes, etc.
    • Then upgrade the submodule versions and finally commit. For example: 
      git submodule init
git submodule update
cd jaeger-ui
git checkout main
git pull
git checkout {new_ui_version} # e.g. v1.5.0
      • If there are only dependency bumps, indicate this with "Dependencies upgrades only" (example).
      • If there are no changes, indicate this with "No changes" (example).
    • Rotate the below release managers table placing yourself at the bottom. The date should be the first Wednesday of the month.
    • Add label changelog:skip to the pull request.
  2. After the PR is merged, create new release tags: 
    git checkout main
git pull
git tag v1... -s  # use the new version
git tag v2... -s  # use the new version
git push upstream v1... v2...
  3. Create a release on Github:
    • Automated:
      • make draft-release
    • Manual:
      • Title "Release 1.x.x / 2.x.x"
      • Tag v1.x.x (note the v prefix) and choose appropriate branch (usually main)
      • Copy the new CHANGELOG.md section into the release notes
      • Extra: GitHub has a button "generate release notes". Those are not formatted as we want, but it has a nice feature of explicitly listing first-time contributors. Before doing the previous step, you can click that button and then remove everything except the New Contributors section. Change the header to ### 👏 New Contributors, then copy the main changelog above it. Example.
  4. Go to Publish Release workflow on GitHub and run it manually using Run Workflow button on the right.
    1. For monitoring and troubleshooting, open the logs of the workflow run from above URL.
    2. Check the images are available on Docker Hub and binaries are uploaded to the releasehttps://github.com/jaegertracing/jaeger/releases.

Patch Release

Sometimes we need to do a patch release, e.g. to fix a newly introduced bug. If the main branch already contains newer changes, it is recommended that a patch release is done from a version branch.

Maintenance branches should follow naming convention: release-major.minor (e.g.release-1.8).

  1. Find the commit in main for the release you want to patch (e.g., a49094c2 for v1.34.0).
  2. git checkout ${commit}; git checkout -b ${branch-name}. The branch name should be in the form release-major.minor, e.g., release-1.34. Push the branch to the upstream repository.
  3. Apply fixes to the branch. The recommended way is to merge the fixes into main first and then cherry-pick them into the version branch (e.g., git cherry-pick c733708c for the fix going into v1.34.1).
  4. Follow the regular process for creating a release (except for the Documentation step).
    • When creating a release on GitHub, pick the version branch when applying the new tag.
    • Once the release tag is created, the ci-release workflow will kick in and deploy the artifacts for the patch release.
  5. Do not perform a new release of the documentation since the major.minor is not changing. The one change that may be useful is bumping the binariesLatest variable in the config.toml file (example).

Release managers

A Release Manager is the person responsible for ensuring that a new version of Jaeger is released. This person will coordinate the required changes, including to the related components such as UI, IDL, and jaeger-lib and will address any problems that might happen during the release, making sure that the documentation above is correct.

In order to ensure that knowledge about releasing Jaeger is spread among maintainers, we rotate the role of Release Manager among maintainers.

Here are the release managers for future versions with the tentative release dates. The release dates are the first Wednesday of the month, and we might skip a release if not enough changes happened since the previous release. In such case, the next tentative release date is the first Wednesday of the subsequent month.

Version Release Manager Tentative release date
1.64.0 @joe-elliott 4 December 2024
1.65.0 @jkowall 8 January 2025
1.66.0 @yurishkuro 3 February 2025
1.67.0 @albertteoh 5 March 2025
1.68.0 @pavolloffay 5 April 2025