Skip to content

Release process

Daniel Chao edited this page Mar 11, 2024 · 7 revisions

Minor version releases

  1. Add release notes to docs/modules/ROOT/pages/CHANGELOG.adoc, submit PR and merge into main.
  2. Commit and create a tag. Make sure the tag has a "v" prefix.
    git tag -a v<VERSION> -m "Release version <VERSION>"
    
  3. Push to upstream
    git push upstream refs/tags/vx.x.x
    
  4. Wait for CI build to complete
  5. Create a release branch
    • git checkout -b release/x.x
    • git push upstream release/x.x
  6. Prepare PR to start next dev iteration
    • docs/antora.yml: change version (no v prefix)
    • VERSION.txt: change version (no v prefix)
    • Commit Start next dev iteration, submit PR and merge after approval

Patch version release

  1. Pre-conditions: all commits are cherry-picked from main branch, committed, and CI is green.
  2. From branch release/x.x: prepare release notes to CHANGELOG.adoc, submit PR to release/x.x branch and merge
  3. Commit and create a tag. Make sure the tag has a "v" prefix.
    git tag -a v<VERSION> -m "Release version <VERSION>"
    
  4. Push to upstream
    git push upstream refs/tags/vx.x.x
    
  5. Wait for CI build to complete
  6. Cherry-pick release notes
    1. Create branch and cherry pick
      git checkout cherry-pick-release-notes main
      git cherry-pick $(git rev-parse release/x.x)
      
    2. Submit PR to main branch and merge
Clone this wiki locally