feat(publish-helm-chart): Add merge-registry-values toggle (#100)

* feat(publish-helm-chart): Add merge registry values toggle

* chore(publish-helm-chart): Add values files to smoke test

* ci: Include publish-helm-action in path to trigger smoke build

* fix(publish-helm-chart): Use correct input in condition

Yikes! This just was silenty skipped. Cool stuff GitHub -.-

* fix(publish-helm-chart): Add GITHUB_DEBUG env var

* refactor(publish-helm-chart): Adjust values file lookup

* chore(smoke): Add .helmignore file

Author: Techassi

.github/workflows/smoke-build.yaml

@@ -9,6 +9,7 @@ on:
       - build-container-image/action.yaml
       - build-product-image/action.yaml
       - free-disk-space/action.yaml
+      - publish-helm-chart/action.yaml
       - publish-image/action.yaml
       - publish-index-manifest/action.yaml
       - send-slack-notification/action.yaml

publish-helm-chart/README.md

@@ -12,17 +12,18 @@ It needs the `id-token: write` permission to be able to sign the Helm chart with
 
 ### Inputs
 
-| Input                     | Required | Description                                                       |
-| ------------------------- | -------- | ----------------------------------------------------------------- |
-| `chart-registry-uri`      | Yes      | The URI of the Helm Chart registry                                |
-| `chart-registry-username` | Yes      | The username used to login to the Helm Chart registry             |
-| `chart-registry-password` | Yes      | The password used to login to the Helm Chart registry             |
-| `chart-repository`        | Yes      | Path to the Helm chart, for example `sdp-charts/kafka-operator`   |
-| `chart-directory`         | Yes      | The directory where the Chart.yaml file is located                |
-| `chart-version`           | Yes      | The Helm Chart version                                            |
-| `app-version`             | Yes      | The app version to set in the Helm Chart                          |
-| `helm-version`            | No       | The version of helm                                               |
-| `publish-and-sign`        | No       | Whether to publish and sign the Helm Chart. `"true"` or `"false"` |
+| Input                     | Required | Description                                                                    |
+| ------------------------- | -------- | ------------------------------------------------------------------------------ |
+| `chart-registry-uri`      | Yes      | The URI of the Helm Chart registry                                             |
+| `chart-registry-username` | Yes      | The username used to login to the Helm Chart registry                          |
+| `chart-registry-password` | Yes      | The password used to login to the Helm Chart registry                          |
+| `chart-repository`        | Yes      | Path to the Helm chart, for example `sdp-charts/kafka-operator`                |
+| `chart-directory`         | Yes      | The directory where the Chart.yaml file is located                             |
+| `chart-version`           | Yes      | The Helm Chart version                                                         |
+| `app-version`             | Yes      | The app version to set in the Helm Chart                                       |
+| `helm-version`            | No       | The version of helm                                                            |
+| `publish-and-sign`        | No       | Whether to publish and sign the Helm Chart. `"true"` or `"false"`              |
+| `merge-registry-values`   | No       | Whether to merge a registry specific `values.yaml` file. `"true"` or `"false"` |
 
 ### Outputs
 

publish-helm-chart/action.yaml

@@ -39,6 +39,12 @@ inputs:
   publish-and-sign:
     description: Whether to publish and sign the packaged Helm Chart. Can be "true" or "false"
     default: "true"
+  merge-registry-values:
+    description: |
+      Whether to merge a registry specific values.yaml file with the common one. Can be "true" or
+      "false". The naming convention is as follows: `{chart-directory}/values/{chart-registry-uri}.yaml`
+    default: "true"
+
 runs:
   using: composite
   steps:
@@ -75,6 +81,26 @@ runs:
         username: ${{ inputs.chart-registry-username }}
         password: ${{ inputs.chart-registry-password }}
 
+    - name: Merge publish target specific values.yaml files
+      if: inputs.merge-registry-values == 'true'
+      env:
+        CHART_REGISTRY_URI: ${{ inputs.chart-registry-uri }}
+        CHART_DIRECTORY: ${{ inputs.chart-directory }}
+        GITHUB_DEBUG: ${{ runner.debug }}
+      shell: bash
+      run: |
+        set -euo pipefail
+        [ -n "$GITHUB_DEBUG" ] && set -x
+
+        # This is directly taken from the official yq examples and merges all
+        # listed files
+        yq eval-all '. as $item ireduce ({}; . * $item )' \
+          "$CHART_DIRECTORY/values/${CHART_REGISTRY_URI}.yaml" \
+          "$CHART_DIRECTORY/values.yaml" \
+          > "$CHART_DIRECTORY/values.merged.yaml"
+
+        mv "$CHART_DIRECTORY/values.merged.yaml" "$CHART_DIRECTORY/values.yaml"
+
     - name: Package Helm Chart
       env:
         CHART_DIRECTORY: ${{ inputs.chart-directory }}
@@ -86,10 +112,6 @@ runs:
         set -euo pipefail
         [ -n "$GITHUB_DEBUG" ] && set -x
 
-        # Set the Helm Chart version
-        # yq ".version = \"$CHART_VERSION\"" < "$CHART_DIRECTORY/Chart.yaml" > "$CHART_DIRECTORY/Chart.new.yaml"
-        # mv "$CHART_DIRECTORY/Chart.new.yaml" "$CHART_DIRECTORY/Chart.yaml"
-
         # Create temporary directory to store the Helm Chart
         TEMP_CHART_DIR=$(mktemp -d)
         echo "TEMP_CHART_DIR=$TEMP_CHART_DIR" | tee -a "$GITHUB_ENV"

smoke/helm-chart/.helmignore

@@ -0,0 +1,2 @@
+.helmignore
+values/

smoke/helm-chart/values.yaml

@@ -0,0 +1,3 @@
+---
+image:
+  repository: smoke/helm-chart

smoke/helm-chart/values/oci.stackable.tech.yaml

@@ -0,0 +1,3 @@
+---
+image:
+  registry: oci.stackable.tech