Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 24 additions & 10 deletions manifest/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,30 @@ func deleteStatusAndTidyMetadata(obj []byte) (map[string]interface{}, error) {

// See the below for the goal of this metadata tidy logic.
// https://github.com/databus23/helm-diff/issues/326#issuecomment-1008253274
if a := metadata["annotations"]; a != nil {
annotations := a.(map[string]interface{})
delete(annotations, "meta.helm.sh/release-name")
delete(annotations, "meta.helm.sh/release-namespace")
delete(annotations, "deployment.kubernetes.io/revision")

if len(annotations) == 0 {
delete(metadata, "annotations")
}
}
pruneNestedMap(metadata, "annotations",
"meta.helm.sh/release-name",
"meta.helm.sh/release-namespace",
"deployment.kubernetes.io/revision",
)
pruneNestedMap(metadata, "labels", "app.kubernetes.io/managed-by")

return objectMap, nil
}

// pruneNestedMap removes the given fields from the nested map found at key in
// target. If the nested map ends up empty afterwards, key itself is removed
// from target.
func pruneNestedMap(target map[string]interface{}, key string, fields ...string) {
sub, ok := target[key].(map[string]interface{})
if !ok {
return
}

for _, field := range fields {
delete(sub, field)
}

if len(sub) == 0 {
delete(target, key)
}
}
34 changes: 31 additions & 3 deletions manifest/util_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,16 @@ func Test_deleteStatusAndTidyMetadata(t *testing.T) {
"metadata": {
"annotations": {
"deployment.kubernetes.io/revision": "1",
"meta.helm.sh/release-name": "test-release",
"meta.helm.sh/release-namespace": "test-ns",
"other-annot": "value"
"meta.helm.sh/release-name": "test-release",
"meta.helm.sh/release-namespace": "test-ns",
"other-annot": "value"
},
"creationTimestamp": "2025-03-03T10:07:50Z",
"generation": 1,
"labels": {
"app": "nginx",
"app.kubernetes.io/managed-by": "Helm"
},
"name": "nginx-deployment",
"namespace": "test-ns",
"resourceVersion": "33648",
Expand Down Expand Up @@ -64,6 +68,9 @@ func Test_deleteStatusAndTidyMetadata(t *testing.T) {
"annotations": map[string]interface{}{
"other-annot": "value",
},
"labels": map[string]interface{}{
"app": "nginx",
},
"name": "nginx-deployment",
"namespace": "test-ns",
},
Expand All @@ -83,6 +90,27 @@ func Test_deleteStatusAndTidyMetadata(t *testing.T) {
},
wantErr: false,
},
{
name: "empty labels are removed",
obj: []byte(`
{
"kind": "ConfigMap",
"metadata": {
"labels": {
"app.kubernetes.io/managed-by": "Helm"
},
"name": "example"
}
}
`),
want: map[string]interface{}{
"kind": "ConfigMap",
"metadata": map[string]interface{}{
"name": "example",
},
},
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down