Merge branch 'ac/add-post-renovate-upgrade-script' into 'main'

allow custom post-renovate-upgrade.sh

See merge request gitlab-com/gl-infra/common-ci-tasks!829

renovate-bot.md

@@ -169,6 +169,17 @@ variables:
 Renovate supports multiple datasources: <https://docs.renovatebot.com/modules/datasource/>, giving flexibility in how new versions are looked up.
+### Post Upgrade Tasks for `.tool-versions`
+
+If a project has an executable `./scripts/renovate-migrations/tool-version-upgrade.sh`, it will be executed automatically with the following environment variables:
+
+- `RENOVATE_POSTUPG_DEP_NAME`: The name of the dependency being updated
+- `RENOVATE_POSTUPG_PACKAGE_FILE`: The filename that the dependency was found in
+- `RENOVATE_POSTUPG_DEP_TYPE`: The dependency type (if extracted - manager-dependent)
+
+This is necessary because Renovate will only run a single `postUpgradeTasks` for each dependency, if you override it for a package
+that is managed by `.tool-versions` it will break the existing script resulting in a merge requist with a failed pipeline.
+
 ### Pinning dependency versions
 If you need Renovate to pin to a specific version of a dependency, add a `constraints` object into `renovate.json`. Simply removing the manual annotation may not work as Renovate will [automatically detect and update some `asdf` dependencies](https://docs.renovatebot.com/modules/manager/asdf/).

scripts/post-renovate-upgrade.sh

@@ -28,6 +28,14 @@ main() {
     ./scripts/update-asdf-version-variables.sh
   fi
+  if [[ -x ./scripts/renovate-migrations/tool-version-upgrade.sh ]]; then
+    echo "Running ./scripts/renovate-migrations/tool-version-upgrade.sh..."
+
+    env RENOVATE_POSTUPG_DEP_NAME="$dep_name" \
+      RENOVATE_POSTUPG_PACKAGE_FILE="$package_file" \
+      ./scripts/renovate-migrations/tool-version-upgrade.sh
+  fi
+
   # When shfmt is updated, rerun the command to apply any new rules
   if { [[ $dep_name == 'mvdan/sh' ]] || [[ $dep_name == 'shfmt' ]]; } && [[ $package_file == '.tool-versions' ]]; then
     echo "Running ${script_dir}/renovate-upgrade-scripts/shfmt.sh..."