Support for bumpVersion when updating helm-values

[chgl]

What would you like Renovate to be able to do?

When the container image tags in Helm value files are updated using the helm-values manager, it should also support bumping the chart version.

Did you already have any implementation ideas?

I've been attempting this in https://github.com/chgl/renovate/tree/add-bumpversion-support-to-helm-values (Let me know if you'd like a WIP PR). But the main challenge I face is that the helm-values manager works on values.yaml files, but the packageFile containing the version that should be bumped is Chart.yaml. I can work around this by opening and reading the Chart.yaml file and get as far as updating the file contents with a bumped version (https://github.com/chgl/renovate/blob/add-bumpversion-support-to-helm-values/lib/manager/helm-values/update.spec.ts#L38), but now I am not sure how to correctly write back the updated contents without majorly updating getUpdatedPackageFiles (it currently incorrectly overwrites values.yaml with the updated contents of Chart.yaml).

I'm definitely interested in working on this.

[rarkins]

I refactored the return signature for bumpPackageVersion so that it's an object. I think it's possible that you could now add bumpedFileName to that object for your purposes - what do you think?

[chgl]

@rarkins Perfect, thank you for your help! I've implemented something in #8240.

[renovate-release]

🎉 This issue has been resolved in version 24.67.0 🎉

The release is available on:

• GitHub release
• 24.67.0

Your semantic-release bot 📦🚀

[viceice]

We need a new pr for this, as the previous caused a bug and had been reverted, see #8926 and #8919

[jmmaloney4]

Any idea when this will be done? This would be a really useful feature for anyone hosting their own helm chart repository (like myself). Thanks!

[chgl]

I hope to get to it eventually, since I do need it myself as well ;). But of course I'd gladly yield the implementation to anyone interested - while there is clearly a bug left to squash, https://github.com/renovatebot/renovate/pull/8240/files may at least be a starting point.

[andywow]

I made workaround with this (bump patch version):

  "postUpgradeTasks": {
    "commands": [
      "sed -i \"s/^version:.*/version: $(grep '^version:' Chart.yaml | awk '{print $2}' | awk -F '[.\"]' '{$NF = $NF + 1;} 1' | sed 's/ /./g')/\" Chart.yaml",
    ],
    "fileFilters": ["Chart.yaml"],
    "executionMode": "branch"
  },

[ap-vishal]

Hello, it would be awesome if we get this working, we use flux together with renovate bot and this is the only missing piece for us.

[asergeant01]

I'm struggling to understand the status of this feature.... if i follow the tickets my understanding is it was committed, merged and released, but there was a bug so it was rolled back? What needs done to implement this - perhaps i can contribute?

[viceice]

Needs a new PR with a fix for #8919

[bukowa]

If anyone is interested here is my example pull request created by renovate bukowa/charts#49
Chart version and readme is bumped automatically by my bot see here for workflow
Should work with multiple repositories but it's not battle tested i hope it helps

There are also some nice things in https://github.com/renovatebot/helm-charts

[justinas-b]

I made workaround with this (bump patch version):

  "postUpgradeTasks": {
    "commands": [
      "sed -i \"s/^version:.*/version: $(grep '^version:' Chart.yaml | awk '{print $2}' | awk -F '[.\"]' '{$NF = $NF + 1;} 1' | sed 's/ /./g')/\" Chart.yaml",
    ],
    "fileFilters": ["Chart.yaml"],
    "executionMode": "branch"
  },

Thanks @andywow ! I found it really useful ;) refactored it a bit

"packageRules": [
  {
    "matchManagers": [
      "helm-requirements",
      "helm-values",
    ],
    "postUpgradeTasks": {
      "commands": [
        `version=$(grep '^version:' {{{parentDir}}}/Chart.yaml | awk '{print $2}')
        major=$(echo $version | cut -d. -f1)
        minor=$(echo $version | cut -d. -f2)
        patch=$(echo $version | cut -d. -f3)
        minor=$(expr $minor + 1)
        echo "Replacing $version with $major.$minor.$patch"
        sed -i "s/^version:.*/version: $\{major\}.$\{minor\}.$\{patch\}/g" {{{parentDir}}}/Chart.yaml
        cat {{{parentDir}}}/Chart.yaml
        `
      ],
      "fileFilters": [
        "**/Chart.yaml",
      ],
      "executionMode": "branch",
    },
  },
]

[dbsmartchain]

@justinas-b does your snippet really work? jq says about incorrect syntax on line 6.
Do you use allowPostUpgradeCommandTemplating and allowedPostUpgradeCommands parameters to get it work? If yes, which value do use for allowedPostUpgradeCommands?
Thank you!

[justinas-b]

@justinas-b does your snippet really work? jq says about incorrect syntax on line 6.
Do you use allowPostUpgradeCommandTemplating and allowedPostUpgradeCommands parameters to get it work? If yes, which value do use for allowedPostUpgradeCommands?
Thank you!

Yep, works like a charm, the exact configuration I referenced. I am using following:

"allowPostUpgradeCommandTemplating": true,
"allowedPostUpgradeCommands":        ["^.*",],

[dbsmartchain]

@justinas-b thank you for a quick reply!
Do you use config.js for:

module.exports = {
  allowPostUpgradeCommandTemplating: true,
  allowedPostUpgradeCommands: ["^.*",],
};

And renovate.json for packageRules?

[alekc]

Hmm, turns out I was not on the latest one (35.10.x). After upgrade it looks like it works as expected, thx

[legonigel]

I'm going to try to revive the reverted PR, but no promises. JS isn't something I usually work with, so will take me some time.

[renovate-release]

🎉 This issue has been resolved in version 37.138.0 🎉

The release is available on:

• GitHub release
• 37.138.0

Your semantic-release bot 📦🚀

[Crapworks]

Hey! So I pulled the new release in and set "bumpVersion": "minor" in my renvate.json, hoping that it would just work and bump the version in Chart.yaml whenever it updates the values.yaml. But the behavior is the same as before, it only updates the values.yaml. From the discussion here and the PR it is not clear to me how this is supposed to work. Do I need to setup / configure something else to make this work?

[rarkins]

@Crapworks please start a non-closed issue or discussion. I'm not sure if this was intended to update both or only values

[morremeyer]

Quick note for everyone wondering why this is not working since #26441 has been merged: #26441 was reverted with #26758 since it did not work as intended.

Edit: Found the revert PR and updated comment with it.

[jkroepke]

I have some hope for #27602 - maybe we could use regex magic to trigger version bump. this also would include versionBump, if there is a change inside the Chart.yaml (e.g. appVersion has been changed)

Note sure, but a vote can help on the discussion.

[morremeyer]

Updates

2024-05-07: Updated the script to work with all types of updates.

Description

We have taken the workaround shown by @justinas-b and built on top of it. Main changes are:

• it's now in a separate file to allow for linting and keep the renovate.json a valid json file
• it bumps the chart version depending on the version bump of the dependency

ℹ️ This only bumps for major, minor and patch upgrades. digests, pins, rollbacks, replacements and pinDigest updates are deliberately ignored since in our use case, these need a manual decision about the version bump for the chart

Setup

• put the script below in scripts/bump-chart-version.sh
• your chart directories need to be in the charts/ directory

Script

Script

#!/usr/bin/env bash

set -euo pipefail

parent_dir="$1"
update_type="$2"

version=$(grep "^version:" "charts/${parent_dir}/Chart.yaml" | awk '{print $2}')
if [[ ! $version ]]; then
  echo "No valid version was found"
  exit 1
fi

major=$(echo "$version" | cut -d. -f1)
minor=$(echo "$version" | cut -d. -f2)
patch=$(echo "$version" | cut -d. -f3)

if [[ "$update_type" =~ (major|replacement) ]]; then
  major=$(( major + 1 ))
  minor=0
  patch=0
elif [[ "$update_type" =~ 'minor' ]]; then
  minor=$(( minor + 1 ))
  patch=0
else
  patch=$(( patch + 1 ))
fi

echo "Bumping version for $parent_dir from $version to $major.$minor.$patch"
sed -i "s/^version:.*/version: ${major}.${minor}.${patch}/g" "charts/${parent_dir}/Chart.yaml"

renovate config

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "packageRules": [
    {
      "description": "Bump helm chart versions by a patch when updating values files. Digests, pins, rollbacks, replacements and pinDigest updates are deliberately ignored since in our use case, these need a manual decision about the version bump for the chart. This can be removed when https://github.com/renovatebot/renovate/issues/8231 is implemented and enabled.",
      "matchManagers": ["helm-values"],
      "postUpgradeTasks": {
        "commands": [
          "bash scripts/bump-chart-version.sh '{{{parentDir}}}' '{{{updateType}}}'"
        ],
        "fileFilters": ["**/Chart.yaml"]
      }
    }
  ]
}

[kastl-ars]

Are you missing these lines in your config.js (the one for the bot, not the one in the repository)?

  allowPostUpgradeCommandTemplating: true,
  allowedPostUpgradeCommands: ["^.*",],

I do not see them at the beginning of the run, where it outputs the config:

DEBUG: File config
       "config": {
         "$schema": "https://docs.renovatebot.com/renovate-schema.json",
         "onboarding": false,
         "username": "renovate-release",
         "gitAuthor": "Renovate Bot <[email protected]>",
         "platform": "github",
         "repositories": ["small-hack/matrix-sliding-sync-chart"]
       }

[jessebot]

I did not have those lines! Great catch :) I've added them here:
https://github.com/small-hack/matrix-sliding-sync-chart/blob/2a125fdb3911bb72c254582a01c86a76294fd828/.github/renovate-config.json

though, I note that allowPostUpgradeCommandTemplating is true by default:
https://docs.renovatebot.com/self-hosted-configuration/#allowpostupgradecommandtemplating

I again deleted the PR, and then re-ran the renovate job here:
https://github.com/small-hack/matrix-sliding-sync-chart/actions/runs/9284539308/job/25547359089

but the newest PR is still the same here:
https://github.com/small-hack/matrix-sliding-sync-chart/pull/15/files

[kastl-ars]

According to the docs your config.js needs a module.exports:
https://docs.renovatebot.com/getting-started/running/#using-configjs

And in the renovate.json I have a line like this, althought I do not think this is the cause why your script does not run:

  "bumpVersion": "patch",

[jessebot]

Thanks again for continuing to dig into this! Unfortunately, I don't think that's the issue, as I am not using config.js. I'm using config.json for the self-hosted config here:
https://github.com/small-hack/matrix-sliding-sync-chart/blob/2a125fdb3911bb72c254582a01c86a76294fd828/.github/renovate-config.json

I don't think module.exports is required for config.json 🤔 This runs via the official self hosted github action and it gets one-time tokens via use of a private key here:
https://github.com/small-hack/matrix-sliding-sync-chart/blob/main/.github/workflows/renovate.yml

The token is valid, or it would have failed immediately. (I know because I have given it an invalid private key in the past, and it broke everything 😅)

[jessebot]

I ended up having to move forward with the repo this thread was troubleshooting, but it works on my home assistant chart. The only change I made was making the script executable and the changes previously discussed by kastl-ars to add the allowed post upgrade command in the self hosted config here: https://github.com/small-hack/home-assistant-chart/blob/main/.github/renovate-config.json

Oh, the other thing I changed was exection mode to be branch:
https://github.com/small-hack/home-assistant-chart/blob/fd9e6103e8a0462a301d5e21f61271c8bfd0d74d/renovate.json#L24

Other than that, I think this is resolved for me :)

[Rajesh-Gurjar]

Hi @morremeyer will this fucntionality be added to renovate or we'll have to via the script version?

[morremeyer]

@Rajesh-Gurjar There is still the goal of supporting this directly in renovate, but it has to be implemented.

For now, using the script in my comment works, but only on self-hosted instances

[babuga365]

We have taken the workaround shown by @justinas-b and built on top of it. Main changes are:

• it's now in a separate file to allow for linting and keep the renovate.json a valid json file
• it bumps the chart version depending on the version bump of the dependency

ℹ️ This only bumps for major, minor and patch upgrades. digests, pins, rollbacks, replacements and pinDigest updates are deliberately ignored since in our use case, these need a manual decision about the version bump for the chart

Setup

• put the script below in scripts/bump-chart-version.sh
• your chart directories need to be in the charts/ directory

Script

Script

renovate config

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "packageRules": [
    {
      "description": "Bump helm chart versions by a patch when updating values files. Digests, pins, rollbacks, replacements and pinDigest updates are deliberately ignored since in our use case, these need a manual decision about the version bump for the chart. This can be removed when https://github.com/renovatebot/renovate/issues/8231 is implemented and enabled.",
      "matchManagers": ["helm-values"],
      "postUpgradeTasks": {
        "commands": [
          "bash scripts/bump-chart-version.sh '{{{parentDir}}}' '{{{isMajor}}}' '{{{isMinor}}}' '{{{isPatch}}}'"
        ],
        "fileFilters": ["**/Chart.yaml"],
        "executionMode": "branch"
      }
    }
  ]
}

If I have multiple charts in single repository under charts folder, this script is working only on first chart and remaining charts were not updated with new version value in Chart.yaml file..

Do you know how to make it work for other charts as well?

[babuga365]

values.yaml is updated for both files, but Chart.yaml is updated only for one chart and remaining one is not updated.
Tried with removing executionMode and still the same

[morremeyer]

Can you share the debug logs for one run against this repository?

[babuga365]

logs_azdo.txt
I didn't have logs of bash script execution and not sure how can I saw logs of those ones in azure devops pipeline

[morremeyer]

@babuga365 I updated the script in #28861 (comment), can you check the new version please?

The old one was buggy for minor updates.

[babuga365]

I have tried and its still not working for this chart only:
portainer-agent.zip

I'm not sure whether this chart is having any issue. I have tried with two more charts and its worked as expected

[rarkins]

I've converted this from Issue to Discussion as it's gotten a bit messy and off-topic for an issue. We will create a clean feature request issue in its place soon.

[jkroepke]

I'm trying to resolve this issues with regexManager approach, see: #27602

Maybe your Feature Request can be bundled with that one: #28045

[jessebot]

Has this clean feature request been created?