Add documentations for the release process of Helm charts #723
Conversation
| helm install ray-cluster kuberay/ray-cluster | ||
| ``` | ||
|
|
||
| ## Delete the existing releases |
There was a problem hiding this comment.
Why do we need to delete existing releases?
Should we maintain Helm release version for each KubeRay release?
There was a problem hiding this comment.
Why do we need to delete existing releases?
Because the chart-releaser will only be triggered when the PR is merged into main, maintainers may want to revert some wrong PRs. For example, a release manager of 0.4.0 forgets to update version from 0.3.0 to 0.4.0 in Chart.yaml, so the existing 0.3.0 releases and index.yaml update. In this case, we need to follow the "Delete the existing releases" section to revert.
Should we maintain Helm release version for each KubeRay release?
Yes
There was a problem hiding this comment.
Ok, makes sense -- could you clarify that deleting charts is only for such situations?
There was a problem hiding this comment.
Actually, I think it already sufficiently conveys that deleting things is not recommended.
Co-authored-by: Dmitri Gekhtman <62982571+DmitriGekhtman@users.noreply.github.com> Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: Dmitri Gekhtman <62982571+DmitriGekhtman@users.noreply.github.com> Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: Dmitri Gekhtman <62982571+DmitriGekhtman@users.noreply.github.com> Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
…t#723) Formalize and document the Helm release process. Co-authored-by: Dmitri Gekhtman <62982571+DmitriGekhtman@users.noreply.github.com> Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Why are these changes needed?
We need to formalize the release process. Documents are helpful.
Related issue number
Closes #724
Checks