Files

811 lines
37 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://ray-project.github.io/kuberay/development/release/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">
<title>Release - KubeRay Docs</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#kuberay-release-process" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="KubeRay Docs" class="md-header__button md-logo" aria-label="KubeRay Docs" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
KubeRay Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Release
</span>
</div>
</div>
</div>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/ray-project/kuberay" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
ray-project/kuberay
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="KubeRay Docs" class="md-nav__button md-logo" aria-label="KubeRay Docs" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
KubeRay Docs
</label>
<div class="md-nav__source">
<a href="https://github.com/ray-project/kuberay" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
ray-project/kuberay
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-ellipsis">
Home
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Home
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Welcome
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#prerequisite" class="md-nav__link">
<span class="md-ellipsis">
Prerequisite
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#steps" class="md-nav__link">
<span class="md-ellipsis">
Steps
</span>
</a>
<nav class="md-nav" aria-label="Steps">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#step-1-create-or-prepare-the-release-branch" class="md-nav__link">
<span class="md-ellipsis">
Step 1: Create or Prepare the Release Branch
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-2-update-kuberay-version-references" class="md-nav__link">
<span class="md-ellipsis">
Step 2: Update KubeRay Version References
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-3-create-and-push-the-git-tag" class="md-nav__link">
<span class="md-ellipsis">
Step 3: Create and Push the Git Tag
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-4-publish-release-images" class="md-nav__link">
<span class="md-ellipsis">
Step 4: Publish Release Images
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-5-publish-kubectl-plugin-release" class="md-nav__link">
<span class="md-ellipsis">
Step 5: Publish Kubectl Plugin Release
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-6-publish-kuberay-helm-charts" class="md-nav__link">
<span class="md-ellipsis">
Step 6: Publish KubeRay Helm Charts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-7-validate-the-release" class="md-nav__link">
<span class="md-ellipsis">
Step 7: Validate the Release
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-8-generate-the-changelog" class="md-nav__link">
<span class="md-ellipsis">
Step 8: Generate the CHANGELOG
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-9-publish-release-notes" class="md-nav__link">
<span class="md-ellipsis">
Step 9: Publish Release Notes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-10-update-rayio-documentation" class="md-nav__link">
<span class="md-ellipsis">
Step 10: Update ray.io documentation
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<!-- markdownlint-disable MD013 -->
<h1 id="kuberay-release-process">KubeRay Release Process<a class="headerlink" href="#kuberay-release-process" title="Permanent link">&para;</a></h1>
<h2 id="prerequisite">Prerequisite<a class="headerlink" href="#prerequisite" title="Permanent link">&para;</a></h2>
<p>You need write access to the <a href="https://github.com/ray-project/kuberay">KubeRay repo</a> to cut a release branch and create a release tag.</p>
<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">&para;</a></h2>
<p>Each KubeRay minor release series (e.g., <code>v1.3.X</code>) is maintained on its own release branch.
For example, the <code>v1.3.X</code> releases are cut from the <code>release-1.3</code> branch.
Patch releases (e.g., <code>v1.3.1</code>) involve cherry-picking commits onto the corresponding release branch.
Release candidates (e.g., <code>v1.4.0-rc.0</code>) are usually cut from the <code>master</code> branch.</p>
<p>The high-level steps for a new minor or patch release are:</p>
<ol>
<li>For new minor releases, create a release branch (e.g., <code>release-1.4</code>) from <code>master</code> if it doesn't exist.</li>
<li>Update KubeRay version references in the release branch.</li>
<li>Create and push a new git tag based on the target release version (e.g., <code>v1.4.0</code>).</li>
<li>Publish container images by running the <code>release-image-build</code> GitHub Actions workflow.</li>
<li>Publish kubectl plugin binaries by running the <code>release-kubectl-plugin</code> GitHub Actions workflow.</li>
<li>Update the <a href="https://github.com/ray-project/kuberay-helm">kuberay-helm</a> repository to publish the new Helm chart versions.</li>
<li>Validate the release artifacts (images, charts).</li>
<li>Generate the CHANGELOG for the release.</li>
<li>Publish the release notes on GitHub Releases.</li>
<li>Update Ray documentation to refer to the new KubeRay version.</li>
</ol>
<p>See the next section for more details on each step.</p>
<h2 id="steps">Steps<a class="headerlink" href="#steps" title="Permanent link">&para;</a></h2>
<p><em>(Example commands use <code>v1.4.0</code> as the target release and <code>release-1.4</code> as the branch.)</em></p>
<hr />
<h3 id="step-1-create-or-prepare-the-release-branch">Step 1: Create or Prepare the Release Branch<a class="headerlink" href="#step-1-create-or-prepare-the-release-branch" title="Permanent link">&para;</a></h3>
<p><strong>For a new minor release (e.g., <code>v1.4.0</code> from <code>master</code>):</strong></p>
<ol>
<li>
<p>Ensure your local <code>master</code> branch is up-to-date:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Ensure you are on the master branch</span>
git<span class="w"> </span>checkout<span class="w"> </span>master
<span class="c1"># Fetch the latest changes from upstream</span>
git<span class="w"> </span>fetch<span class="w"> </span>upstream
<span class="c1"># Reset your local master to match the upstream master</span>
git<span class="w"> </span>reset<span class="w"> </span>--hard<span class="w"> </span>upstream/master
<span class="c1"># Or, if you have local changes you need to manage carefully:</span>
<span class="c1"># git pull --rebase upstream master</span>
</code></pre></div>
</li>
<li>
<p>Create the release branch (e.g., <code>release-1.4</code>) from <code>upstream/master</code>:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Create the branch locally from the latest upstream master</span>
git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>release-1.4<span class="w"> </span>upstream/master
</code></pre></div>
</li>
<li>
<p>Push the new release branch to the <code>upstream</code> repository:</p>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>push<span class="w"> </span>upstream<span class="w"> </span>release-1.4
</code></pre></div>
</li>
<li>
<p>Set the upstream tracking branch locally to avoid accidentally merging <code>master</code> later:</p>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>branch<span class="w"> </span>--set-upstream-to<span class="w"> </span>upstream/release-1.4
</code></pre></div>
</li>
<li>
<p><strong>Verify CI:</strong> GitHub Actions workflows run on <code>master</code> and all <code>release-*</code> branches. Check the <a href="https://github.com/ray-project/kuberay/actions">Actions tab</a> for the <code>kuberay</code> repository and ensure all workflows are passing on the newly created <code>release-1.4</code> branch.</p>
</li>
<li>
<p>Update Ray CI to trigger nightly tests against the new kuberay release branch. See <a href="https://github.com/ray-project/ray/pull/51539">example PR #51539</a>.</p>
</li>
</ol>
<hr />
<h3 id="step-2-update-kuberay-version-references">Step 2: Update KubeRay Version References<a class="headerlink" href="#step-2-update-kuberay-version-references" title="Permanent link">&para;</a></h3>
<p>On the release branch (<code>release-1.4</code> in this example), update all references to the KubeRay version number (e.g., <code>1.4.0</code>).</p>
<p>Update the version in the following files:</p>
<ul>
<li><code>helm-chart/kuberay-apiserver/Chart.yaml</code> (chart version)</li>
<li><code>helm-chart/kuberay-apiserver/values.yaml</code> (image tag)</li>
<li><code>helm-chart/kuberay-operator/Chart.yaml</code> (chart version)</li>
<li><code>helm-chart/kuberay-operator/values.yaml</code> (image tag)</li>
<li><code>helm-chart/ray-cluster/Chart.yaml</code> (chart version)</li>
<li><code>ray-operator/config/default/kustomization.yaml</code> (image tag)</li>
<li><code>ray-operator/controllers/ray/utils/constant.go</code> (<code>KUBERAY_VERSION</code> constant)</li>
</ul>
<p>Open a PR to the release branch with these changes.
Refer to a previous version bump PR for guidance, like <a href="https://github.com/ray-project/kuberay/pull/3071/files">PR #3071</a>.</p>
<hr />
<h3 id="step-3-create-and-push-the-git-tag">Step 3: Create and Push the Git Tag<a class="headerlink" href="#step-3-create-and-push-the-git-tag" title="Permanent link">&para;</a></h3>
<ol>
<li>
<p>Ensure you are on the correct release branch and it includes the version bump commit:</p>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>checkout<span class="w"> </span>release-1.4
git<span class="w"> </span>pull<span class="w"> </span>--rebase<span class="w"> </span>upstream<span class="w"> </span>release-1.4
</code></pre></div>
</li>
<li>
<p>Verify the latest commit is the version bump commit:</p>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>log<span class="w"> </span>-1
<span class="c1"># Check the commit message and changes:</span>
<span class="c1"># git show</span>
</code></pre></div>
</li>
<li>
<p>Create the git tag (using the <code>vX.Y.Z</code> format, e.g., <code>v1.4.0</code>):</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Create a tag</span>
git<span class="w"> </span>tag<span class="w"> </span>v1.4.0
</code></pre></div>
</li>
<li>
<p>Push the tag to the <code>upstream</code> repository:</p>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>push<span class="w"> </span>upstream<span class="w"> </span>v1.4.0
</code></pre></div>
</li>
</ol>
<hr />
<h3 id="step-4-publish-release-images">Step 4: Publish Release Images<a class="headerlink" href="#step-4-publish-release-images" title="Permanent link">&para;</a></h3>
<p>Trigger the <a href="https://github.com/ray-project/kuberay/actions/workflows/image-release.yaml"><code>release-image-build</code></a> workflow to build and publish the KubeRay container images.</p>
<ol>
<li>Navigate to the workflow page: <a href="https://github.com/ray-project/kuberay/actions/workflows/image-release.yaml">https://github.com/ray-project/kuberay/actions/workflows/image-release.yaml</a></li>
<li>Click the <strong>"Run workflow"</strong> dropdown button.</li>
<li>Set the parameters:<ul>
<li><strong>Use workflow from:</strong> Select <strong><code>Tags</code></strong> and choose the tag you just pushed (e.g., <strong><code>v1.4.0</code></strong>).</li>
</ul>
</li>
<li>Click <strong>"Run workflow"</strong>.</li>
</ol>
<p><strong>Verification:</strong> Monitor the workflow run. Once completed successfully, check that the corresponding image tags are available on <a href="https://quay.io/repository/kuberay/operator?tab=tags">quay.io</a>.</p>
<hr />
<h3 id="step-5-publish-kubectl-plugin-release">Step 5: Publish Kubectl Plugin Release<a class="headerlink" href="#step-5-publish-kubectl-plugin-release" title="Permanent link">&para;</a></h3>
<p>Trigger the <a href="https://github.com/ray-project/kuberay/actions/workflows/kubectl-plugin-release.yaml"><code>release-kubectl-plugin</code></a> workflow to build and publish the <code>kubectl-ray</code> binary.</p>
<ol>
<li>Navigate to the workflow page: <a href="https://github.com/ray-project/kuberay/actions/workflows/kubectl-plugin-release.yaml">https://github.com/ray-project/kuberay/actions/workflows/kubectl-plugin-release.yaml</a></li>
<li>Click the <strong>"Run workflow"</strong> dropdown button.</li>
<li>Set the parameters:<ul>
<li><strong>Use workflow from:</strong> Select <strong><code>Tags</code></strong> and choose the tag for the release (e.g., <strong><code>v1.4.0</code></strong>).</li>
</ul>
</li>
<li>Click <strong>"Run workflow"</strong>.</li>
</ol>
<p><strong>Verification:</strong></p>
<ul>
<li>Monitor the workflow run for success.</li>
<li>Check the <a href="https://github.com/ray-project/kuberay/releases">KubeRay Releases page</a>. A draft release corresponding to the tag <code>v1.4.0</code> should have been created (or updated if it existed) with the plugin binaries attached as assets.</li>
<li>The workflow should automatically open a Pull Request in the <a href="https://github.com/kubernetes-sigs/krew-index">krew-index repository</a> to update the plugin version for <code>kubectl krew</code>. Check for this PR and ensure it looks correct. It might require manual approval/merge by krew maintainers.</li>
</ul>
<hr />
<h3 id="step-6-publish-kuberay-helm-charts">Step 6: Publish KubeRay Helm Charts<a class="headerlink" href="#step-6-publish-kuberay-helm-charts" title="Permanent link">&para;</a></h3>
<p>Helm charts are published via the <a href="https://github.com/ray-project/kuberay-helm">ray-project/kuberay-helm</a> repository. This repo uses release branches (<code>release-X.Y</code>) mirroring the main <code>kuberay</code> repo.
See <a href="./helm-chart.md">helm-chart.md</a> for the end-to-end workflow. Below are steps to cut a new release branch in the kuberay-helm repo and publish new charts.</p>
<ol>
<li>
<p><strong>Create Release Branch (if it doesn't exist):</strong></p>
<ul>
<li>Clone the <code>kuberay-helm</code> repository if you haven't already.</li>
<li>Set up an <code>upstream</code> remote: <code>git remote add upstream [email protected]:ray-project/kuberay-helm.git</code></li>
<li>
<p>If the branch <code>release-1.4</code> does <em>not</em> exist in <code>kuberay-helm</code>:</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>kuberay-helm
git<span class="w"> </span>fetch<span class="w"> </span>upstream
<span class="c1"># Create the branch from the latest main branch</span>
git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>release-1.4<span class="w"> </span>upstream/main
git<span class="w"> </span>push<span class="w"> </span>upstream<span class="w"> </span>release-1.4
<span class="c1"># Set tracking branch</span>
git<span class="w"> </span>branch<span class="w"> </span>--set-upstream-to<span class="w"> </span>upstream/release-1.4
<span class="nb">cd</span><span class="w"> </span>..
</code></pre></div>
</li>
<li>
<p><em>Note:</em> Creating a new release branch might trigger CI in <code>kuberay-helm</code>, but it shouldn't publish new chart versions yet as the chart files haven't changed.</p>
</li>
</ul>
</li>
<li>
<p><strong>Sync Helm Charts:</strong></p>
<ul>
<li>
<p>Ensure your local <code>kuberay</code> repository is on the release branch (<code>release-1.4</code>) and up-to-date (including the version bump from Step 2).</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>kuberay
git<span class="w"> </span>checkout<span class="w"> </span>release-1.4
git<span class="w"> </span>pull<span class="w"> </span>--rebase<span class="w"> </span>upstream<span class="w"> </span>release-1.4
<span class="nb">cd</span><span class="w"> </span>..
</code></pre></div>
</li>
<li>
<p>Copy the updated Helm charts from the <code>kuberay</code> repo to the <code>kuberay-helm</code> repo. <em>This assumes <code>kuberay</code> and <code>kuberay-helm</code> are in the same parent directory.</em></p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>kuberay-helm
<span class="c1"># Ensure you are on the correct release branch</span>
git<span class="w"> </span>checkout<span class="w"> </span>release-1.4
git<span class="w"> </span>pull<span class="w"> </span>--rebase<span class="w"> </span>upstream<span class="w"> </span>release-1.4
<span class="c1"># Remove old charts first to handle deleted files</span>
rm<span class="w"> </span>-rf<span class="w"> </span>helm-chart/
<span class="c1"># Copy the updated charts from the kuberay repo</span>
cp<span class="w"> </span>-R<span class="w"> </span>../kuberay/helm-chart/<span class="w"> </span>.
</code></pre></div>
</li>
</ul>
</li>
<li>
<p><strong>Commit and Create Pull Request:</strong></p>
<ul>
<li>
<p>Stage the changes in the <code>kuberay-helm</code> repository:</p>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>status<span class="w"> </span><span class="c1"># Verify changes</span>
git<span class="w"> </span>add<span class="w"> </span>helm-chart/
git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;Update Helm charts to KubeRay v1.4.0&quot;</span>
</code></pre></div>
</li>
<li>
<p>Push the changes to your fork of <code>kuberay-helm</code> (or directly if you have permissions, though PR is safer):</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Example assuming &#39;origin&#39; remote points to your fork</span>
git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>release-1.4
</code></pre></div>
</li>
<li>
<p>Open a Pull Request from your fork. See <a href="https://github.com/ray-project/kuberay-helm/pull/54">example PR #54</a>.</p>
</li>
</ul>
</li>
<li>
<p><strong>Merge and Verify:</strong></p>
<ul>
<li>Once the PR is reviewed and merged, monitor the GitHub Actions workflows in the <code>kuberay-helm</code> repository:<ul>
<li><a href="https://github.com/ray-project/kuberay-helm/actions/workflows/chart-release.yaml"><code>chart-release</code></a></li>
<li><a href="https://github.com/ray-project/kuberay-helm/actions/workflows/pages/pages-build-deployment"><code>pages-build-deployment</code></a></li>
</ul>
</li>
<li>Verify that both workflows succeed. This indicates the charts have been packaged and added to the Helm repository index hosted via GitHub Pages.</li>
</ul>
</li>
</ol>
<hr />
<h3 id="step-7-validate-the-release">Step 7: Validate the Release<a class="headerlink" href="#step-7-validate-the-release" title="Permanent link">&para;</a></h3>
<p>Perform basic validation to ensure the released artifacts work together.</p>
<ol>
<li>
<p>Update your local Helm repository:</p>
<div class="highlight"><pre><span></span><code>helm<span class="w"> </span>repo<span class="w"> </span>add<span class="w"> </span>kuberay<span class="w"> </span>https://ray-project.github.io/kuberay-helm/
helm<span class="w"> </span>repo<span class="w"> </span>update<span class="w"> </span>kuberay
</code></pre></div>
</li>
<li>
<p>Search for the new chart versions:</p>
<div class="highlight"><pre><span></span><code>helm<span class="w"> </span>search<span class="w"> </span>repo<span class="w"> </span>kuberay/kuberay-operator<span class="w"> </span>--versions
helm<span class="w"> </span>search<span class="w"> </span>repo<span class="w"> </span>kuberay/ray-cluster<span class="w"> </span>--versions
<span class="c1"># Verify that version 1.4.0 (or your target version) appears</span>
</code></pre></div>
</li>
<li>
<p>Install KubeRay using the new chart versions on a test cluster (e.g., Kind, Minikube):</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Example using Kind</span>
kind<span class="w"> </span>create<span class="w"> </span>cluster
<span class="c1"># Install the operator using the specific version</span>
helm<span class="w"> </span>install<span class="w"> </span>kuberay-operator<span class="w"> </span>kuberay/kuberay-operator<span class="w"> </span>--version<span class="w"> </span>&lt;new-version&gt;
<span class="c1"># Install a sample RayCluster using the specific chart version</span>
helm<span class="w"> </span>install<span class="w"> </span>raycluster<span class="w"> </span>kuberay/ray-cluster<span class="w"> </span>--version<span class="w"> </span>&lt;new-version&gt;
</code></pre></div>
</li>
<li>
<p>Check the pods and basic functionality:</p>
<div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>get<span class="w"> </span>pods
</code></pre></div>
<p>You should see the kuberay-operator pod in <code>Running</code> state and 1 active RayCluster.</p>
</li>
<li>
<p>Validate Go modules are published:</p>
<div class="highlight"><pre><span></span><code>go<span class="w"> </span>install<span class="w"> </span>github.com/ray-project/kuberay/[email protected]
</code></pre></div>
</li>
<li>
<p>Open a PR to the master branch to update the version for KubeRay upgrade tests and make sure all tests pass. Example PR: #3825</p>
</li>
</ol>
<hr />
<h3 id="step-8-generate-the-changelog">Step 8: Generate the CHANGELOG<a class="headerlink" href="#step-8-generate-the-changelog" title="Permanent link">&para;</a></h3>
<p>Follow <a href="https://github.com/ray-project/kuberay/blob/master/docs/release/changelog.md">Generating the changelog for a release</a> to generate the change log for the new release.</p>
<hr />
<h3 id="step-9-publish-release-notes">Step 9: Publish Release Notes<a class="headerlink" href="#step-9-publish-release-notes" title="Permanent link">&para;</a></h3>
<ol>
<li>Go to the <a href="https://github.com/ray-project/kuberay/releases">KubeRay Releases page</a>.</li>
<li>Find the <strong>draft release</strong> that was created automatically in Step 5 or create a new one if needed, targeting the tag <code>v1.4.0</code>.</li>
<li>Click <strong>"Edit"</strong> on the draft release.</li>
<li>Paste the generated <strong>CHANGELOG</strong> content from Step 8 into the release description.</li>
<li>Add any additional release highlights, bug fixes, known issues, etc.</li>
<li>Ensure the correct tag (<code>v1.4.0</code>) is selected.</li>
<li>Verify the attached assets (kubectl plugins) are correct.</li>
<li>Mark the release as <strong>"Latest release"</strong> if appropriate (usually for the newest stable release).</li>
<li>Click <strong>"Publish release"</strong>.</li>
</ol>
<p>Announce the new release in the <a href="https://ray.slack.com/archives/C01CKH05XBN">kuberay Slack channel</a>.</p>
<hr />
<h3 id="step-10-update-rayio-documentation">Step 10: Update ray.io documentation<a class="headerlink" href="#step-10-update-rayio-documentation" title="Permanent link">&para;</a></h3>
<p>Update all references to the KubeRay version in the ray.io documentation.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>
</body>
</html>