Skip to content

feat: add functionality to helm-update-chart to match on an alias #5902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
aaron-lunsford-even wants to merge 1 commit into
base: main
Choose a base branch
from
+45 −3
Draft

feat: add functionality to helm-update-chart to match on an alias #5902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs/50-user-guide/60-reference-docs/30-promotion-steps/helm-update-chart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ referenced by the Freight being promoted. This step is commonly followed by a
| `charts` | `[]object` | N | The details of dependency (subchart) updates to be applied to the chart's `Chart.yaml` file. When left unspecified, charts will be updated according to the SemVer ranges declared in the `Chart.yaml` file. |
| `charts[].repository` | `string` | Y | The URL of the Helm chart repository in the `dependencies` entry whose `version` field is to be updated. Must _exactly_ match the `repository` field of that entry. |
| `charts[].name` | `string` | Y | The name of the chart in in the `dependencies` entry whose `version` field is to be updated. Must exactly match the `name` field of that entry. |
Copy link
Copy Markdown
Contributor

@EronWright EronWright Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is name now optional? Appears to be mutually exclusive with alias. Can't you always match on name in addition to alias? Could you give a couple of examples in the description?

Copy link
Copy Markdown
Member

@krancour krancour Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Helm uses repository + name together as the full identifier for a chart.

The right thing here would be to have the repository + name pair mutually exclusive with alias.

Copy link
Copy Markdown
Member

@krancour krancour Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pkg/promotion/runner/builtin/schemas/helm-update-chart-config.json would be the right place to codify that.

Then you need to run make hack-codegen to re-generate step configuration from that modified schema.

Then pkg/promotion/runner/builtin/helm_chart_updater.go needs changes to propagate the new configuration option down to the lower level code you already modified.

I'm going to change this to a draft for now.

| `charts[].alias` | `string` | N | Optional. The `alias` of the dependency in `Chart.yaml`. When specified, only the dependency with this alias is matched (e.g. when the same chart is listed multiple times with different aliases). When omitted, matching is by repository and name only. |
| `charts[].version` | `string` | Y | The version to which the dependency should be updated. |

## Output
Expand Down
1 change: 1 addition & 0 deletions pkg/helm/dependency.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ type ChartDependency struct {
Repository string `json:"repository,omitempty"`
Name string `json:"name,omitempty"`
Version string `json:"version,omitempty"`
Alias string `json:"alias,omitempty"`
}

// chartMetadata is a minimal representation of a Helm chart's metadata
Expand Down
12 changes: 9 additions & 3 deletions pkg/helm/dependency_manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,13 @@ func (em *EphemeralDependencyManager) processDependencyUpdates(
for _, update := range updates {
var found bool
for i, dep := range dependencies {
if dep.Name == update.Name && dep.Repository == update.Repository {
var matched bool
if update.Alias != "" {
matched = dep.Alias == update.Alias
} else {
matched = dep.Name == update.Name
}
if matched && dep.Repository == update.Repository {
found = true
// If the version is different, add the updated dependency
if dep.Version != update.Version {
Expand All @@ -363,8 +369,8 @@ func (em *EphemeralDependencyManager) processDependencyUpdates(
}
if !found {
return fmt.Errorf(
"no dependency in Chart.yaml matches update with repository %q and name %q",
update.Repository, update.Name,
"no dependency in Chart.yaml matches update with repository %q and name %q or alias %q",
update.Repository, update.Name, update.Alias,
)
}
}
Expand Down
34 changes: 34 additions & 0 deletions pkg/helm/dependency_manager_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,6 +632,40 @@ version: 1.0.0
assert.ErrorContains(t, err, `no dependency in Chart.yaml matches update`)
},
},
{
name: "match by alias when present",
chartFile: `name: test-chart
version: 1.0.0
dependencies:
- name: redis
repository: https://charts.bitnami.com/bitnami
version: 16.0.0
alias: redis-session
- name: redis
repository: https://charts.bitnami.com/bitnami
version: 17.0.0
alias: redis-cache
- name: redis
repository: https://charts.bitnami.com/bitnami
version: 12.0.0
alias: redis-sentinel
`,
updates: []ChartDependency{
{Name: "redis", Repository: "https://charts.bitnami.com/bitnami", Version: "18.0.0", Alias: "redis-cache"},
{Name: "redis", Repository: "https://charts.bitnami.com/bitnami", Version: "13.0.0", Alias: "redis-sentinel"},
},
assertions: func(t *testing.T, chartPath string, err error) {
assert.NoError(t, err)

dependencies, err := GetChartDependencies(chartPath)
assert.NoError(t, err)
assert.Equal(t, []ChartDependency{
{Name: "redis", Repository: "https://charts.bitnami.com/bitnami", Version: "16.0.0", Alias: "redis-session"},
{Name: "redis", Repository: "https://charts.bitnami.com/bitnami", Version: "18.0.0", Alias: "redis-cache"},
{Name: "redis", Repository: "https://charts.bitnami.com/bitnami", Version: "13.0.0", Alias: "redis-sentinel"},
}, dependencies)
},
},
}

for _, tt := range tests {
Expand Down
Loading