You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by cc...@apache.org on 2022/12/22 16:26:52 UTC

[yunikorn-site] branch master updated: [YUNIKORN-1294] release procedure update gh-pages (#241)

This is an automated email from the ASF dual-hosted git repository.

ccondit pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git


The following commit(s) were added to refs/heads/master by this push:
     new b6ef0f6a0 [YUNIKORN-1294] release procedure update gh-pages (#241)
b6ef0f6a0 is described below

commit b6ef0f6a0563b0b719272a43e936334bb774d284
Author: Wilfred Spiegelenburg <wi...@apache.org>
AuthorDate: Thu Dec 22 10:26:31 2022 -0600

    [YUNIKORN-1294] release procedure update gh-pages (#241)
    
    As part of the release the gh-pages index.md file must be updated to
    show the new K8s versions, etc.
    
    Closes: #241
    
    Signed-off-by: Craig Condit <cc...@apache.org>
---
 src/pages/community/release_procedure.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/src/pages/community/release_procedure.md b/src/pages/community/release_procedure.md
index e4cebb15e..0734dcd00 100644
--- a/src/pages/community/release_procedure.md
+++ b/src/pages/community/release_procedure.md
@@ -248,9 +248,11 @@ The helm package will generate two files:
 - helm package: example `yunikorn-0.8.0.tgz`
 - provenance or signature file: example `yunikorn-0.8.0.tgz.prov`
 
-Both files should be attached to the [release in GIT](#create-the-git-releases) for the release repository.
+Both files _must_ be attached to the [release in GIT](#create-the-git-releases) for the release repository.
 
-Last step is to update the [index.yaml](https://github.com/apache/yunikorn-release/blob/gh-pages/index.yaml) file in the `gh-pages` branch with the new release.
+Last step is to update the [index.yaml](https://github.com/apache/yunikorn-release/blob/gh-pages/index.yaml) and
+[index.md](https://github.com/apache/yunikorn-release/blob/gh-pages/index.md) file in the `gh-pages` branch with the new release.
+First the `index.yaml` file:  
 The `digest` mentioned in the index.yaml file is the digest that gets printed by the tool (unsigned package) or stored in the provenance file.
 It can be generated manually using:
 ```shell script
@@ -260,6 +262,14 @@ shasum -a 256 yunikorn-0.8.0.tgz
 Note: do not use the `helm repo index` command to update the `index.yaml` file. The command does not handle the enhanced information stored in the `index.yaml` file nicely.
 Update the file manually.
 
+In the same PR update the `index.md` file. In most cases the change is limited to the supported Kubernetes versions.
+If there are no changes for the release this step can be skipped. Larger changes should be tracked as a separate jira not as a work item for a release. 
+Releases are always tracked based on the minor release only, i.e. 1.23.x or 1.25.x.
+Multiple Kubernetes versions can be added as supported from the current release. Each version should be mentioned as a separate entry under the **K8s Version** column.
+The current YuniKorn release is added to the **Supported from version** and **Support ended** as needed.
+
+Any change in supported Kubernetes versions _must_ be mentioned in the [release announcement](#release-announcement).  
+
 #### Update the website
 - Create a new documentation version on YuniKorn website based on the latest content in the `docs` directory.
   Refer to [these steps](#version-the-documentation) on how to create the new documentation version.