Merge pull request #21 from SoftwareAG/dev-readme

Improve README documentation
SoftwareAG · Dec 8, 2023 · 111b6c6 · 111b6c6
2 parents 5c11444 + 172d831
commit 111b6c6
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/.github/workflows/gen-readme-values.yml b/.github/workflows/gen-readme-values.yml
@@ -5,8 +5,9 @@ on:
     branches-ignore:
       - main                     # Run on all not 'main' branches
     paths:
-      - '**/helm/values.yaml'    # Only if values.yaml is pushed
-
+      - '**/helm/values.yaml'         # Only if values.yaml or ... 
+      - '**/helm/README.md.gotmpl'    #     ... README.md.gotmpl is pushed
+
 jobs:
   release:
     permissions:

diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ webmethods/apigateway           1.0.0           10.15           API Gateway Helm
 webmethods/common               1.0.0           1.0.0           A Library Helm Chart for grouping common logic ...
 webmethods/developerportal      1.0.0           10.15           webMethods Developer Portal Helm Chart for Kube...
 webmethods/microservicesruntime 1.0.0           10.15           Microservices Runtime (MSR) Helm Chart for Kube...
-webmethods/universalmessaging   1.0.0           10.15           Universal Messaging (UM) Helm Chart for Kubernetes
+webmethods/universalmessaging   1.0.1           10.15           Universal Messaging (UM) Helm Chart for Kubernetes
 ```
 
 ## Available Charts READMEs
@@ -34,6 +34,10 @@ Each chart has a README for *how to use* and lists some prerequisites.
 | [mywebmethodsserver](https://github.com/SoftwareAG/webmethods-helm-charts/blob/main/mywebmethodsserver/helm/README.md) | My webMethods Server (MWS) |
 | [universalmessaging](https://github.com/SoftwareAG/webmethods-helm-charts/blob/main/universalmessaging/helm/README.md) | Universal Messaging (UM) |
 
+## Chart Versions
+
+Per default, Helm uses the latest version on release installation. If you have successfully installed a webMethods release, you should notice the current used Chart version. Therefore, on further release installation oder upgrades (with `helm upgrade --install`) you should use the `--version X.Y.Z` to guarantee that the same is installed everywhere.
+
 ## Utilities
 
 To adopt Microservices Runtime for your deployment and environment or to build images, there is a collection of utilities:

diff --git a/universalmessaging/helm/README.md b/universalmessaging/helm/README.md
@@ -43,7 +43,7 @@ helm install um webmethods/universalmessaging
 | Version | Changes and Description |
 |-----|------|
 | `1.0.0' | Initial release |
-| `1.0.1' | Update JMX Exporter configuration file with . Bigfix: Mount configuration files into container. Nginx added. |
+| `1.0.1' | Update JMX Exporter configuration file from latest [UM Git repository](https://github.com/SoftwareAG/universalmessaging-prometheus-jmx-exporter-config). Bugfix: Mount configuration files into container. Nginx added. |
 
 ## Values
 

diff --git a/universalmessaging/helm/README.md.gotmpl b/universalmessaging/helm/README.md.gotmpl
@@ -43,6 +43,6 @@ helm install um webmethods/universalmessaging
 | Version | Changes and Description |
 |-----|------|
 | `1.0.0' | Initial release |
-| `1.0.1' | Update JMX Exporter configuration file with . Bigfix: Mount configuration files into container. Nginx added. |
+| `1.0.1' | Update JMX Exporter configuration file from latest [UM Git repository](https://github.com/SoftwareAG/universalmessaging-prometheus-jmx-exporter-config). Bugfix: Mount configuration files into container. Nginx added. |
 
 {{ template "chart.valuesSection" . }}