Updated clearml-serving README and CI (#313)

* Changed: updated Readme * Changed: CI actions versions * Changed: CI default test values * Fixed: newline * Changed: tests for CI * Fixed: newline * Changed: removed CI values customization --------- Co-authored-by: fbrintazzoli <[email protected]>
allegroai · Aug 21, 2024 · bf17429 · bf17429
1 parent adcb4b0
commit bf17429
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 11 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].7
         with:
           fetch-depth: 0
       - name: Run helm-docs
@@ -29,15 +29,15 @@ jobs:
           - v1.30.0
     steps:
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].7
         with:
           fetch-depth: 0
       - name: Create kind ${{ matrix.k8s }} cluster
-        uses: helm/kind-action@v1.8.0
+        uses: helm/kind-action@v1.10.0
         with:
           node_image: kindest/node:${{ matrix.k8s }}
       - name: Set up chart-testing
-        uses: helm/chart-testing-action@v2.5.0
+        uses: helm/chart-testing-action@v2.6.1
         with:
           version: v3.8.0
       - name: Add bitnami repo

diff --git a/charts/clearml-serving/Chart.yaml b/charts/clearml-serving/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: clearml-serving
 description: ClearML Serving Helm Chart
 type: application
-version: "1.5.6"
+version: "1.5.7"
 appVersion: "1.3.0"
 kubeVersion: ">= 1.21.0-0 < 1.31.0-0"
 home: https://clear.ml
@@ -11,8 +11,8 @@ sources:
   - https://github.com/allegroai/clearml-helm-charts
   - https://github.com/allegroai/clearml
 maintainers:
-  - name: valeriano-manassero
-    url: https://github.com/valeriano-manassero
+  - name: filippo-clearml
+    url: https://github.com/filippo-clearml
 keywords:
   - clearml
   - "machine learning"
@@ -33,5 +33,5 @@ dependencies:
     condition: grafana.enabled
 annotations:
   artifacthub.io/changes: |
-    - kind: added
-      description: k8s 1.30 support
+    - kind: changed
+      description: Updated README
diff --git a/charts/clearml-serving/README.md b/charts/clearml-serving/README.md
@@ -1,6 +1,6 @@
 # ClearML Kubernetes Serving
 
-![Version: 1.5.6](https://img.shields.io/badge/Version-1.5.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.3.0](https://img.shields.io/badge/AppVersion-1.3.0-informational?style=flat-square)
+![Version: 1.5.7](https://img.shields.io/badge/Version-1.5.7-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.3.0](https://img.shields.io/badge/AppVersion-1.3.0-informational?style=flat-square)
 
 ClearML Serving Helm Chart
 
@@ -10,13 +10,21 @@ ClearML Serving Helm Chart
 
 | Name | Email | Url |
 | ---- | ------ | --- |
-| valeriano-manassero |  | <https://github.com/valeriano-manassero> |
+| filippo-clearml |  | <https://github.com/filippo-clearml> |
 
 ## Introduction
 
 The **clearml-serving** is the Kubernetes serving for for [ClearML](https://github.com/allegroai/clearml-serving).
 It allows you to serve models on a Kubernetes cluster.
 
+## Add to local Helm repository
+
+To add this chart to your local Helm repository:
+
+```
+helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
+```
+
 # Upgrading Chart
 
 ## Upgrades/ Values upgrades

diff --git a/charts/clearml-serving/README.md.gotmpl b/charts/clearml-serving/README.md.gotmpl
@@ -14,6 +14,14 @@
 The **clearml-serving** is the Kubernetes serving for for [ClearML](https://github.com/allegroai/clearml-serving).
 It allows you to serve models on a Kubernetes cluster.
 
+## Add to local Helm repository
+
+To add this chart to your local Helm repository:
+
+```
+helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
+```
+
 # Upgrading Chart
 
 ## Upgrades/ Values upgrades