Add version script

README.md

@@ -35,7 +35,7 @@ The output should be something like:
 
 ```
 NAME                    CHART VERSION   APP VERSION     DESCRIPTION                 
-operaton/operaton-bpm   1.0.0           1.0.0-beta-3    Helm chart for Operaton BPM 
+operaton/operaton-bpm   1.0.1           1.0.0-beta-3    Helm chart for Operaton BPM
 ```
 
 Note: The `--devel` flag includes development versions in the search results. Without this flag, only stable versions will be listed.
@@ -45,19 +45,19 @@ Note: The `--devel` flag includes development versions in the search results. Wi
 To install a specific version from the list above, use:
 
 ```shell
-helm install operaton operaton/operaton-bpm --version 1.0.0
+helm install operaton operaton/operaton-bpm --version 1.0.1
 ```
 
 In this example:
 
 * The Operaton BPM chart will be installed under the release name `operaton`
-* The version `1.0.0` will be used
+* The version `1.0.1` will be used
 * The installation will take place in the `default` namespace.
 
 To install the chart in a specific namespace, add the `-n YOUR_NAMESPACE` flag:
 
 ```shell
-helm install operaton operaton/operaton-bpm --version 1.0.0 -n YOUR_NAMESPACE
+helm install operaton operaton/operaton-bpm --version 1.0.1 -n YOUR_NAMESPACE
 ```
 
 ### Verify the Installation
@@ -70,7 +70,7 @@ You should be able to see your chart installed having the status `deployed` like
 
 ```
 NAME                    NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                           APP VERSION 
-operaton                default         1               2025-02-28 10:20:34.586319 +0100 CET    deployed        operaton-bpm-1.0.0              1.0.0-beta-3
+operaton                default         1               2025-02-28 10:20:34.586319 +0100 CET    deployed        operaton-bpm-1.0.1              1.0.0-beta-3
 ```
 
 ### Uninstall the chart

README.tpl.md

@@ -0,0 +1,103 @@
+# operaton-helm
+Helm Charts for Operaton
+
+## How to install
+### Add the Helm Chart Repository
+To add the Helm chart repository for Operaton, run:  
+
+```shell
+helm repo add operaton https://operaton.github.io/operaton-helm/
+```
+
+### Verify the Repository
+To confirm that the repository has been added successfully, list all available repositories:
+
+```shell
+helm repo list
+```
+
+### Update Helm Repositories
+Fetch the latest available chart versions by updating your Helm repositories:
+
+```shell
+helm repo update
+```
+
+### List Available Operaton Versions
+
+To check the available versions of the Operaton BPM chart, use the following command:
+
+```shell
+helm search repo operaton-bpm --devel
+```
+
+The output should be something like:
+
+```
+NAME                    CHART VERSION   APP VERSION     DESCRIPTION                 
+operaton/operaton-bpm   {{ CHART_VERSION }}           1.0.0-beta-3    Helm chart for Operaton BPM
+```
+
+Note: The `--devel` flag includes development versions in the search results. Without this flag, only stable versions will be listed.
+
+### Install a Specific Version
+
+To install a specific version from the list above, use:
+
+```shell
+helm install operaton operaton/operaton-bpm --version {{ CHART_VERSION }}
+```
+
+In this example:
+
+* The Operaton BPM chart will be installed under the release name `operaton`
+* The version `{{ CHART_VERSION }}` will be used
+* The installation will take place in the `default` namespace.
+
+To install the chart in a specific namespace, add the `-n YOUR_NAMESPACE` flag:
+
+```shell
+helm install operaton operaton/operaton-bpm --version {{ CHART_VERSION }} -n YOUR_NAMESPACE
+```
+
+### Verify the Installation
+
+```shell
+helm list -A
+```
+
+You should be able to see your chart installed having the status `deployed` like below:
+
+```
+NAME                    NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                           APP VERSION 
+operaton                default         1               2025-02-28 10:20:34.586319 +0100 CET    deployed        operaton-bpm-{{ CHART_VERSION }}              1.0.0-beta-3
+```
+
+### Uninstall the chart
+
+To uninstall the chart, you can use the command below:
+
+```shell
+helm uninstall operaton
+```
+
+## Security
+The default security settings for the container are configured under `securityContext` in `values.yaml`.
+These settings are appropriate for using Operaton with an H2 database. For production use,
+where an external database is used, consider enabling the setting `readOnlyRootFilesystem: true`
+to ensure that the root file system of your container remains read-only.
+
+## Performance and Resource Consumption
+The configuration related to resource consumption (CPU and memory) can be found under `resources` in `values.yaml`.
+The default settings allocate a minimum of 250 milli-CPU cores and 512Mi of memory, with a maximum limit of 1 CPU core
+and 1Gi of memory per pod. This ensures fair resource usage within your cluster and prevents
+a single pod from exhausting available resources.
+With these settings, a new pod typically starts in around 20 seconds. If your cluster allows
+for higher resource allocation, consider increasing the values under `limits` to enhance performance.
+
+## Autoscaling
+By default, autoscaling is disabled for this chart. However, it is highly recommended to enable
+it for production use. The autoscaling settings can be found under `autoscaling` in `values.yaml`.
+The current configuration scales up by adding a new instance when the average CPU usage
+across existing instances exceeds 80%. Please note that autoscaling requires a minimum amount
+of resources per pod, which can be defined under `resources.requests`.

charts/operaton-bpm/Chart.yaml

@@ -3,7 +3,7 @@ name: operaton-bpm
 description: |
   Helm chart for Operaton BPM
 type: application
-version: 1.0.0
+version: 1.0.1
 appVersion: 1.0.0-beta-3
 keywords:
   - bpm
@@ -13,7 +13,7 @@ keywords:
   - dmn
   - process-engine
   - workflow
-icon: https://docs.operaton.org/get-started/img/operaton-circle.svg
+icon: https://operaton.github.io/operaton-helm/operaton-logo.png
 home: https://operaton.org
 sources:
   - https://github.com/operaton/operaton-helm/tree/main/charts/operaton-bpm

set-version.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+NEW_VERSION=$1
+CURRENT_VERSION=$(cat charts/operaton-bpm/Chart.yaml |grep version |sed 's/version: //')
+
+if [ -z "$1" ]; then
+  echo "⚠️ You did not provide the new version. Incrementing the minor version of the current version."
+  CURRENT_VERSION=$(grep '^version:' charts/operaton-bpm/Chart.yaml | sed 's/version: //')
+  IFS='.' read -r MAJOR MINOR PATCH <<< "$CURRENT_VERSION"
+  NEW_VERSION="$MAJOR.$((MINOR + 1)).0"
+else
+  NEW_VERSION=$1
+fi
+
+
+echo "🔍 Current project version is $CURRENT_VERSION, updating to $NEW_VERSION"
+
+echo "🔄 Updating version in README.md"
+sed -e "s/{{ CHART_VERSION }}/$NEW_VERSION/g" README.tpl.md > README.md
+
+echo "🔄 Updating version in Chart.yml"
+sed -i '' -e "s/^version: .*/version: $NEW_VERSION/" charts/operaton-bpm/Chart.yaml
+
+echo "✅ Version updated to $NEW_VERSION"