Don't include annotations: key when there are no annotations (#163)

Author: nicksnyder

charts/sourcegraph-migrator/templates/migrator/sourcegraph-migrator.Job.yaml

@@ -16,13 +16,13 @@ spec:
   template:
     metadata:
       annotations:
+        kubectl.kubernetes.io/default-container: migrator
       {{- if .Values.sourcegraph.podAnnotations }}
       {{- toYaml .Values.sourcegraph.podAnnotations | nindent 8 }}
       {{- end }}
       {{- if .Values.migrator.podAnnotations }}
       {{- toYaml .Values.migrator.podAnnotations | nindent 8 }}
       {{- end }}
-        kubectl.kubernetes.io/default-container: migrator
       labels:
       {{- include "sourcegraph.selectorLabels" . | nindent 8 }}
       {{- if .Values.sourcegraph.podLabels }}

charts/sourcegraph/CHANGELOG.md

@@ -8,6 +8,7 @@ Use `**BREAKING**:` to denote a breaking change
 
 ## Unreleased
 
+- (lint) Don't emit `annotations` key on k8s objects if the value is empty [#163](https://github.com/sourcegraph/deploy-sourcegraph-helm/pull/163)
 
 ## 3.43.0
 

charts/sourcegraph/templates/frontend/sourcegraph-frontend-internal.Service.yaml

@@ -1,10 +1,10 @@
 apiVersion: v1
 kind: Service
 metadata:
+  {{- if .Values.frontend.serviceAnnotations }}
   annotations:
-    {{- if .Values.frontend.serviceAnnotations }}
     {{- toYaml .Values.frontend.serviceAnnotations | nindent 4 }}
-    {{- end }}
+  {{- end }}
   labels:
     app: sourcegraph-frontend
     deploy: sourcegraph

charts/sourcegraph/templates/frontend/sourcegraph-frontend.Ingress.yaml

@@ -2,10 +2,10 @@
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
+  {{- if .Values.frontend.ingress.annotations}}
   annotations:
-    {{- if .Values.frontend.ingress.annotations}}
     {{- toYaml .Values.frontend.ingress.annotations | nindent 4 }}
-    {{- end }}
+  {{- end }}
   labels:
     app: sourcegraph-frontend
     deploy: sourcegraph

charts/sourcegraph/templates/grafana/grafana.Service.yaml

@@ -2,8 +2,8 @@
 apiVersion: v1
 kind: Service
 metadata:
-  annotations:
   {{- if .Values.grafana.serviceAnnotations }}
+  annotations:
   {{- toYaml .Values.grafana.serviceAnnotations | nindent 4 }}
   {{- end }}
   labels:

charts/sourcegraph/templates/indexed-search/indexed-search.StatefulSet.yaml

@@ -21,12 +21,14 @@ spec:
   serviceName: indexed-search
   template:
     metadata:
+      {{- if or .Values.sourcegraph.podAnnotations .Values.indexedSearch.podAnnotations }}
       annotations:
-      {{- if .Values.sourcegraph.podAnnotations }}
-      {{- toYaml .Values.sourcegraph.podAnnotations | nindent 8 }}
-      {{- end }}
-      {{- if .Values.indexedSearch.podAnnotations }}
-      {{- toYaml .Values.indexedSearch.podAnnotations | nindent 8 }}
+        {{- if .Values.sourcegraph.podAnnotations }}
+        {{- toYaml .Values.sourcegraph.podAnnotations | nindent 8 }}
+        {{- end }}
+        {{- if .Values.indexedSearch.podAnnotations }}
+        {{- toYaml .Values.indexedSearch.podAnnotations | nindent 8 }}
+        {{- end }}
       {{- end }}
       labels:
       {{- include "sourcegraph.selectorLabels" . | nindent 8 }}

charts/sourcegraph/templates/jaeger/jaeger-collector.Service.yaml

@@ -2,8 +2,8 @@
 apiVersion: v1
 kind: Service
 metadata:
-  annotations:
   {{- if .Values.tracing.collector.serviceAnnotations }}
+  annotations:
   {{- toYaml .Values.tracing.collector.serviceAnnotations | nindent 4 }}
   {{- end }}
   labels:

charts/sourcegraph/templates/jaeger/jaeger-query.Service.yaml

@@ -2,8 +2,8 @@
 apiVersion: v1
 kind: Service
 metadata:
-  annotations:
   {{- if .Values.tracing.query.serviceAnnotations }}
+  annotations:
   {{- toYaml .Values.tracing.query.serviceAnnotations | nindent 4 }}
   {{- end }}
   labels:

charts/sourcegraph/templates/prometheus/prometheus.Service.yaml

@@ -2,10 +2,10 @@
 apiVersion: v1
 kind: Service
 metadata:
+  {{- if .Values.prometheus.serviceAnnotations }}
   annotations:
-    {{- if .Values.prometheus.serviceAnnotations }}
     {{- toYaml .Values.prometheus.serviceAnnotations | nindent 4 }}
-    {{- end }}
+  {{- end }}
   labels:
     app: prometheus
     deploy: sourcegraph

charts/sourcegraph/templates/storageclass.yaml

@@ -6,10 +6,10 @@ metadata:
   labels:
     {{- include "sourcegraph.labels" . | nindent 4 }}
     deploy: sourcegraph-storage
+  {{- if .Values.storageClass.annotations}}
   annotations:
-    {{- if .Values.storageClass.annotations}}
     {{- toYaml .Values.storageClass.annotations | nindent 4 }}
-    {{- end }}
+  {{- end }}
 provisioner: {{ .Values.storageClass.provisioner }}
 parameters:
   {{- with .Values.storageClass.type }}