Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Change Helm chart version

Recipe IDorg.openrewrite.kubernetes.helm.ChangeChartVersion

Artifactorg.openrewrite.recipe:rewrite-kubernetes

Propagate a Helm chart version across every file that restates it: the chart's own Chart.yaml, the dependencies of the charts that consume it, Flux HelmRelease resources, k0rdent ClusterTemplate, ProviderTemplate and ServiceTemplate resources, and optionally files whose name encodes the version. dependencies[].version is a range, so by default a range that the new version already satisfies is left alone rather than pinned. Chart.lock is never edited, because its digest cannot be recomputed here; it is reported instead. Files under a chart's templates directory are Go template text and are left alone. A k0rdent template's metadata.name also encodes the chart version, but a name is an identity that ClusterDeployment, Release and *TemplateChain resources point at. Renaming it here would leave those references dangling, so this recipe changes only version fields; org.openrewrite.kubernetes.k0rdent.ChangeTemplateVersion moves the name and everything that references it together.

Single recipeOpenRewriteModerne Proprietary License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

6 parameters

2 required4 optional

Parameter	Example	Type	Required
chartName	k0smotron	String	Required
The name of the chart whose version is changing, as it is written in its Chart.yaml and in the dependencies of the charts that consume it.
newVersion	1.3.0	String	Required
The new chart version. Must be an exact semantic version.
matchMode	—	MatchMode	Optional
How to treat the range-valued version fields, dependencies[].version in a Chart.yaml and spec.chart.spec.version in a Flux HelmRelease. The exact-valued fields, a chart's own version and appVersion, are always set exactly. Default is Widen.
newAppVersion	v1.3.0	String	Optional
The new appVersion for the chart. A chart's appVersion names the application it packages, which usually moves independently of the chart version, so it is left alone unless this is set.
oldVersion	1.2.0	String	Optional
The version being replaced. When omitted, the version the chart's own Chart.yaml currently declares is used, which is only knowable for a chart that lives in this repository.
renameFilesMatching	**/files/release/*.yaml	String	Optional
A glob expression selecting files whose name encodes the version. Matching files are renamed, substituting the new version for the old in either 1.2.3 or 1-2-3 spelling. When omitted, nothing is renamed.

Examples

yaml, yaml, yaml

Parameter	Value
chartName	app
oldVersion	null
newVersion	2.0.0
newAppVersion	null
matchMode	null
renameFilesMatching	null

yaml

Before

apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
  name: app
spec:
  chart:
    spec:
      chart: app
      version: 1.2.0
---
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
  name: other
spec:
  chart:
    spec:
      chart: other
      version: 1.2.0

After

apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
  name: app
spec:
  chart:
    spec:
      chart: app
      version: 2.0.0
---
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
  name: other
spec:
  chart:
    spec:
      chart: other
      version: 1.2.0

Diff

--- clusters/dev/releases.yaml
+++ clusters/dev/releases.yaml
@@ -9,1 +9,1 @@
    spec:
      chart: app
-     version: 1.2.0
+     version: 2.0.0
---

yaml

Before

apiVersion: v2
name: app
version: 1.2.0

After

apiVersion: v2
name: app
version: 2.0.0

Diff

--- charts/app/Chart.yaml
+++ charts/app/Chart.yaml
@@ -3,1 +3,1 @@
apiVersion: v2
name: app
-version: 1.2.0
+version: 2.0.0

yaml

Before

apiVersion: v2
name: parent
version: 0.1.0
dependencies:
  - name: app
    version: ^1.2.0
    repository: file://../app

After

apiVersion: v2
name: parent
version: 0.1.0
dependencies:
  - name: app
    version: ^2.0.0
    repository: file://../app

Diff

--- charts/parent/Chart.yaml
+++ charts/parent/Chart.yaml
@@ -6,1 +6,1 @@
dependencies:
  - name: app
-   version: ^1.2.0
+   version: ^2.0.0
    repository: file://../app

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ChangeChartVersion --recipe-option "chartName=k0smotron" --recipe-option "oldVersion=1.2.0" --recipe-option "newVersion=1.3.0" --recipe-option "newAppVersion=v1.3.0" --recipe-option "renameFilesMatching='**/files/release/*.yaml'"

If the recipe is not available locally, then you can install it using:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

RELEASE

mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:RELEASE

LATEST

mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:LATEST

Pinned version

mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:3.18.0

Data tables

Helm chart version changes

org.openrewrite.kubernetes.table.HelmChartVersionChanges

Every place a chart version was propagated to, plus the places that were deliberately left alone.

Column	Description
Source path	The path of the file the version was found in.
Field	The field the version was found in, relative to the document root.
Old value	The value before the change. For a range this is the range, not a version.
New value	The value after the change, or the unchanged value when no change was made.
Outcome	One of Changed, Renamed, Already satisfied when the new version already satisfies an existing range, Compound range when the range is too complex to rewrite safely, or Lock file when a Chart.lock needs regenerating.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.