Document update process

warpstreamlabs · Oct 4, 2023 · f14ef0f · f14ef0f
1 parent a7b2e53
commit f14ef0f
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,3 +2,10 @@
 
 This repository contains WarpStream's official Helm charts and automatically
 publishes them to the Helm repo, located at [warpstreamlabs.github.io/charts](https://warpstreamlabs.github.io/charts).
+
+This project relies on [chart-releaser Action](https://github.com/helm/chart-releaser-action)
+to package/update/publish Helm charts. When new commits are pushed on `main`,
+[Chart Releaser](https://github.com/helm/chart-releaser) scans folders under `charts/`
+for new versions and creates the corresponding GitHub Releases.
+
+For publishing a new Chart release, push a commit incrementing `version` in `Chart.yaml`.