helm: add `arkade chart bump` to bump chart versions #1024

aryan9600 · 2024-01-22T14:13:33Z

Description

Add a new command arkade chart bump --dir ./chart to bump the minor of a Helm chart version. By default, the changes are written to stdout. Specifying the --write flag writes the changes to the respective file.
Specifying the flag --check-for-value-updates skips bumping the chart version if the adjacent values file does not have any changes according to the Git.

Motivation and Context

I have raised an issue to propose this change, which has been given a label of design/approved by a maintainer (required)
Closes Workflow improvement - increment Chart.yaml version when updating values.yaml #1023

How Has This Been Tested?

Built the CLI manually and tested various scenarios:

Relative paths:

# Single chart
❯ ../../arkade/arkade chart bump --dir ./charts/flagger
charts/flagger/Chart.yaml 1.35.0 => 1.36.0

# Multiple charts
❯ ../../arkade/arkade chart bump --dir ./charts --recursive
Found 4 charts
charts/flagger/Chart.yaml 1.35.0 => 1.36.0
charts/grafana/Chart.yaml 1.7.0 => 1.8.0
charts/loadtester/Chart.yaml 0.30.0 => 0.31.0
charts/podinfo/Chart.yaml 6.1.3 => 6.2.0

# Write enabled
❯ ../../arkade/arkade chart bump --dir ./charts --recursive --write
Found 4 charts
charts/flagger/Chart.yaml 1.35.0 => 1.36.0
charts/grafana/Chart.yaml 1.7.0 => 1.8.0
charts/loadtester/Chart.yaml 0.30.0 => 0.31.0
charts/podinfo/Chart.yaml 6.1.3 => 6.2.0

❯ git --no-pager diff
diff --git a/charts/flagger/Chart.yaml b/charts/flagger/Chart.yaml
index 6df33502..31ccf27a 100644
--- a/charts/flagger/Chart.yaml
+++ b/charts/flagger/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v1
 name: flagger
-version: 1.35.0
+version: 1.36.0
 appVersion: 1.35.0
 kubeVersion: ">=1.19.0-0"
 engine: gotpl
# ...omitted for brevity

Absolute paths:

# Single chart
❯ ./arkade chart bump --dir ~/Development/fluxcd/flagger/charts/flagger
/Users/sanskarjaiswal/Development/fluxcd/flagger/charts/flagger/Chart.yaml 1.36.0 => 1.37.0

# Multiple charts
❯ ./arkade chart bump --dir ~/Development/fluxcd/flagger/charts --recursive
Found 4 charts
/Users/sanskarjaiswal/Development/fluxcd/flagger/charts/flagger/Chart.yaml 1.36.0 => 1.37.0
/Users/sanskarjaiswal/Development/fluxcd/flagger/charts/grafana/Chart.yaml 1.8.0 => 1.9.0
/Users/sanskarjaiswal/Development/fluxcd/flagger/charts/loadtester/Chart.yaml 0.31.0 => 0.32.0
/Users/sanskarjaiswal/Development/fluxcd/flagger/charts/podinfo/Chart.yaml 6.2.0 => 6.3.0

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Documentation

I have updated the list of tools in README.md if (required) with ./arkade get --format markdown
I have updated the list of apps in README.md if (required) with ./arkade install --help

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I've read the CONTRIBUTION guide
I have signed-off my commits with git commit -s

I have tested this on arm, or have added code to prevent deployment

alexellis · 2024-01-22T15:28:40Z

Thanks for the PR and the detailed test output.

I'm thinking a bit more about workflow.

What if only one of the charts has changes pending from the upgrade command?

I.e. the Makefile in openfaas/faas-netes has a make upgrade-charts target, and possibly only one or two charts will need a bump due to changes in image versions.

Maybe simulate that? https://github.com/openfaas/faas-netes

Back off a version of "image" in two charts, then run the make upgrade-charts followed by thinking about how we could only bump the adjacent images?

And what if someone ran make upgrade charts twice, we wouldn't want to bump the version twice etc.

Other charts have a single values.yaml like - https://github.com/inlets/inlets-operator/blob/master/chart/inlets-operator/values.yaml#L44

Alex

alexellis · 2024-01-22T15:41:39Z

To simplify things, we could assume the workflow of:

make upgrade-charts

make bump-charts

The first uses the existing command, the second uses the new one. The maintainer won't run the second command twice in a row, otherwise they'll get a double bump. The first command is still re-runnable.

We could skip --recursive in this PR, and if we want to add it later, make sure it's in both commands so they are consistent.

aryan9600 · 2024-01-22T17:53:39Z

Is the intention with the new workflow to only bump charts when the image in the chart gets updated? Or do we want to bump the chart version regardless of what action make upgrade-charts resulted in?

alexellis · 2024-01-22T18:03:45Z

Is the intention with the new workflow to only bump charts when the image in the chart gets updated? Or do we want to bump the chart version regardless of what action make upgrade-charts resulted in?

Sorry that I was unclear. Can you walk through the example I shared?

Maintainer knows there are new releases for 1 or more openfaas charts
He runs make upgrade-charts - this re-writes the file, but perhaps not all images are published, so he has to run it again (we don't want to bump the chart twice as a combined option)
He runs make bump-charts

Suggest one or more ways that you can determine if a values.yaml has changed, and then only bump its adjacent Chart.yaml if that's the case.

upgrade-charts:
	@echo Upgrading images for all helm charts && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/openfaas/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/kafka-connector/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/cron-connector/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/nats-connector/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/mqtt-connector/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/pro-builder/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/sqs-connector/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/postgres-connector/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/queue-worker/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/sns-connector/values.yaml && \
	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/federated-gateway/values.yaml

So the same would be repeated i.e.

bump-charts
	arkade chart bump --verbose=$(VERBOSE) -w -f ./chart/federated-gateway/values.yaml && \
	arkade chart bump --verbose=$(VERBOSE) -w -f ./chart/kafka-connector/values.yaml && \
...

aryan9600 · 2024-01-22T20:23:47Z

If we only want to bump the version in Chart.yaml if we have changes in the adjacent values.yaml, I guess we can modify arkade chart bump to use Git and figure out whether there actually are any changes in the values.yaml file.
But this does introduce a prerequisite for Git to be installed on the system and for the working directory to be a Git repository. Maybe we can hide this functionality behind a flag such as --check-for-value-updates, so it doesn't affect regular usage.

aryan9600 · 2024-01-23T14:30:46Z

One more approach we can take is to combine the upgrade and bump process under one command and make it interactive. For example, after all the images are upgraded, we could prompt the user and ask whether they want to bump the chart as well. This way you can run the new command several times to try and upgrade images without bumping the version twice. The drawback here is that its not CI friendly and you need to know analyze which images got updated.

alexellis · 2024-01-23T16:51:33Z

Hi @aryan9600

I like your suggestion to use git.

Could we go go-execute to execute "git status" and then just scan if there's a values.yaml affected from the output?

Go bindings to git may require CGO, which I'd like to avoid.

Let me know if you think that's feasible?

For instance:

$ git status --short
 M chart/inlets-uplink/Chart.yaml
 M chart/inlets-uplink/values.yaml

Alex

aryan9600 · 2024-01-23T16:57:11Z

We could also use go-git if we wanted to do things in a more programatic manner. But then again, if you don't want to introduce several packages for one feature, we could go the go-execute route.

alexellis · 2024-01-24T12:16:26Z

Do you want to go ahead and try go-execute please?

alexellis · 2024-01-25T11:07:07Z

The functionality looks good now, I'd like the user experience to be consistent and to default to doing the obvious thing:

	arkade chart upgrade --verbose=$(VERBOSE) -w -f ./chart/openfaas/values.yaml && \

So, here's how the bump may work:

	arkade chart bump --verbose=$(VERBOSE) -w -f ./chart/openfaas/values.yaml

Please always bump the patch version by default, if maintainers want to bump major or release version, they can do that manually.

One other thought to bear in mind is that if any file in the folder of values.yaml has changed, then a bump is needed. I.e. you added an environment variable to a template YAML file.

alexellis · 2024-01-31T16:40:50Z

@aryan9600 hey are you still working on this?

Add a new command `arkade chart bump --dir ./chart` to bump the minor of a Helm chart version. To bump multiple charts at once, specify the parent directory with the `--recursive` flag. By default, the changes are written to stdout. Specifying the `--write` flag writes the changes to the respective file. Signed-off-by: Sanskar Jaiswal <[email protected]> njndjnd

Add flag `--check-for-value-updates` to `arkade chart bump` which skips bumping the chart version if the values file does not have any changes according to the Git. Signed-off-by: Sanskar Jaiswal <[email protected]>

Signed-off-by: Sanskar Jaiswal <[email protected]>

derek bot added the new-contributor label Jan 22, 2024

aryan9600 force-pushed the chart-bump branch from 6e1749d to cbd2998 Compare January 25, 2024 07:06

aryan9600 added 3 commits February 6, 2024 12:07

allow checking for value changes before bumping helm chart version

bc9421d

Add flag `--check-for-value-updates` to `arkade chart bump` which skips bumping the chart version if the values file does not have any changes according to the Git. Signed-off-by: Sanskar Jaiswal <[email protected]>

increment patch version and make UX consistent

6f1b328

Signed-off-by: Sanskar Jaiswal <[email protected]>

aryan9600 force-pushed the chart-bump branch from cbd2998 to 6f1b328 Compare February 6, 2024 06:37

alexellis mentioned this pull request Feb 16, 2024

helm: add arkade chart bump to bump chart versions #1030

Merged

alexellis closed this in #1030 Feb 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

helm: add `arkade chart bump` to bump chart versions #1024

helm: add `arkade chart bump` to bump chart versions #1024

aryan9600 commented Jan 22, 2024 •

edited

Loading

alexellis commented Jan 22, 2024 •

edited

Loading

alexellis commented Jan 22, 2024

aryan9600 commented Jan 22, 2024

alexellis commented Jan 22, 2024 •

edited

Loading

aryan9600 commented Jan 22, 2024

aryan9600 commented Jan 23, 2024

alexellis commented Jan 23, 2024 •

edited

Loading

aryan9600 commented Jan 23, 2024

alexellis commented Jan 24, 2024

alexellis commented Jan 25, 2024

alexellis commented Jan 31, 2024

helm: add arkade chart bump to bump chart versions #1024

helm: add arkade chart bump to bump chart versions #1024

Conversation

aryan9600 commented Jan 22, 2024 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Documentation

Checklist:

alexellis commented Jan 22, 2024 • edited Loading

alexellis commented Jan 22, 2024

aryan9600 commented Jan 22, 2024

alexellis commented Jan 22, 2024 • edited Loading

aryan9600 commented Jan 22, 2024

aryan9600 commented Jan 23, 2024

alexellis commented Jan 23, 2024 • edited Loading

aryan9600 commented Jan 23, 2024

alexellis commented Jan 24, 2024

alexellis commented Jan 25, 2024

alexellis commented Jan 31, 2024

helm: add `arkade chart bump` to bump chart versions #1024

helm: add `arkade chart bump` to bump chart versions #1024

aryan9600 commented Jan 22, 2024 •

edited

Loading

alexellis commented Jan 22, 2024 •

edited

Loading

alexellis commented Jan 22, 2024 •

edited

Loading

alexellis commented Jan 23, 2024 •

edited

Loading