Ensure commonLabels are included in all relevant objects

Summary

Context: !2010 (comment 584867688)

My understanding is that for the most part, anywhere standardLabels are included, commonLabels should be included as well. From searching the templates, it appears that:

All calls to commonLabels are next to calls to standardLabels ✅
Not all calls to standardLabels are next to commonLabels ❌

Steps to reproduce

If you run rg "gitlab.standardLabels" -A1 -B1, you can find instances where commonLabels are not included next to standardLabels.

Current behavior

Some templates include 'gitlab.standardLabels' but not 'gitlab.commonLabels'.

My findings are collected below, but keep in mind this should be done again when addressing the issue to make sure no new occurrences are left out.

List of files to tweak

templates/application.yaml
templates/shared-secrets/_jobspec.yaml
templates/shared-secrets/_self-signed-cert-job.yml
templates/shared-secrets/configmap.yaml
templates/shared-secrets/_rbac-serviceaccount.yaml
templates/upgrade_check_hook.yaml
templates/initdb-configmap.yaml
templates/chart-info.yaml
charts/nginx-ingress/templates/clusterrole.yaml
charts/nginx-ingress/templates/controller-configmap-udp.yaml
charts/nginx-ingress/templates/controller-service-internal.yaml
charts/nginx-ingress/templates/default-backend-serviceaccount.yaml
charts/nginx-ingress/templates/default-backend-psp.yaml
charts/nginx-ingress/templates/default-backend-deployment.yaml
charts/nginx-ingress/templates/default-backend-role.yaml
charts/nginx-ingress/templates/controller-rolebinding.yaml
charts/nginx-ingress/templates/controller-servicemonitor.yaml
charts/nginx-ingress/templates/controller-hpa.yaml
charts/nginx-ingress/templates/default-backend-service.yaml
charts/nginx-ingress/templates/controller-service.yaml
charts/nginx-ingress/templates/controller-configmap-tcp.yaml
charts/nginx-ingress/templates/controller-keda.yaml
charts/nginx-ingress/templates/clusterrolebinding.yaml
charts/nginx-ingress/templates/controller-service-metrics.yaml
charts/nginx-ingress/templates/controller-role.yaml
charts/nginx-ingress/templates/controller-service-webhook.yaml
charts/nginx-ingress/templates/default-backend-poddisruptionbudget.yaml
charts/nginx-ingress/templates/controller-prometheusrules.yaml
charts/nginx-ingress/templates/default-backend-rolebinding.yaml
charts/certmanager-issuer/templates/_issuer.yaml
charts/nginx-ingress/templates/controller-psp.yaml
charts/nginx-ingress/templates/controller-serviceaccount.yaml
charts/nginx-ingress/templates/controller-configmap-addheaders.yaml
charts/nginx-ingress/templates/controller-deployment.yaml
charts/nginx-ingress/templates/default-backend-hpa.yaml
charts/nginx-ingress/templates/controller-configmap.yaml
charts/nginx-ingress/templates/controller-daemonset.yaml
charts/nginx-ingress/templates/controller-configmap-proxyheaders.yaml
charts/nginx-ingress/templates/controller-poddisruptionbudget.yaml
charts/certmanager-issuer/templates/rbac-config.yaml
charts/certmanager-issuer/templates/cert-manager.yml-
charts/certmanager-issuer/templates/cert-manager.yml:{{-
charts/certmanager-issuer/templates/cert-manager.yml-data:
charts/certmanager-issuer/templates/issuer-job.yaml
charts/gitlab/charts/operator/templates/deployment.yaml
charts/gitlab/charts/operator/templates/rbac.yaml
charts/gitlab/charts/gitlab-grafana/templates/ingress.yaml
charts/gitlab/charts/operator/templates/gitlab.yaml
charts/gitlab/charts/gitlab-grafana/templates/import-secret-configmap.yaml
charts/gitlab/charts/gitlab-grafana/templates/datasource-configmap.yaml
charts/gitlab/charts/migrations/templates/configmap.yaml

Full results list

templates/application.yaml-  labels:
templates/application.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/application.yaml-spec:
--
templates/shared-secrets/_jobspec.yaml-  labels:
templates/shared-secrets/_jobspec.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/shared-secrets/_jobspec.yaml-{{- if and $sharedSecretValues.enabled (not .Values.global.operator.enabled) }}
--
templates/shared-secrets/_self-signed-cert-job.yml-  labels:
templates/shared-secrets/_self-signed-cert-job.yml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/shared-secrets/_self-signed-cert-job.yml-{{- if not .Values.global.operator.enabled }}
--
templates/shared-secrets/configmap.yaml-  labels:
templates/shared-secrets/configmap.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/shared-secrets/configmap.yaml-{{- if not .Values.global.operator.enabled }}
--
templates/shared-secrets/configmap.yaml-  labels:
templates/shared-secrets/configmap.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/shared-secrets/configmap.yaml-data:
--
templates/shared-secrets/_rbac-serviceaccount.yaml-  labels:
templates/shared-secrets/_rbac-serviceaccount.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/shared-secrets/_rbac-serviceaccount.yaml-{{- if and $sharedSecretValues.enabled (not .Values.global.operator.enabled) }}
--
templates/upgrade_check_hook.yaml-  labels:
templates/upgrade_check_hook.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/upgrade_check_hook.yaml-  annotations:
--
templates/upgrade_check_hook.yaml-  labels:
templates/upgrade_check_hook.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/upgrade_check_hook.yaml-  annotations:
--
templates/initdb-configmap.yaml-  labels:
templates/initdb-configmap.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/initdb-configmap.yaml-data:
--
templates/chart-info.yaml-  labels:
templates/chart-info.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
templates/chart-info.yaml-data:
--
charts/nginx-ingress/templates/clusterrole.yaml-  labels:
charts/nginx-ingress/templates/clusterrole.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/clusterrole.yaml-    {{- include "ingress-nginx.labels" . | nindent 4 }}
--
charts/nginx-ingress/templates/controller-configmap-udp.yaml-  labels:
charts/nginx-ingress/templates/controller-configmap-udp.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-configmap-udp.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-service-internal.yaml-  labels:
charts/nginx-ingress/templates/controller-service-internal.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-service-internal.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/default-backend-serviceaccount.yaml-  labels:
charts/nginx-ingress/templates/default-backend-serviceaccount.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/default-backend-serviceaccount.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/default-backend-psp.yaml-  labels:
charts/nginx-ingress/templates/default-backend-psp.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/default-backend-psp.yaml-    component: "{{ .Values.defaultBackend.name }}"
--
charts/nginx-ingress/templates/default-backend-deployment.yaml-  labels:
charts/nginx-ingress/templates/default-backend-deployment.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/default-backend-deployment.yaml-    component: "{{ .Values.defaultBackend.name }}"
--
charts/nginx-ingress/templates/default-backend-role.yaml-  labels:
charts/nginx-ingress/templates/default-backend-role.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/default-backend-role.yaml-    component: "{{ .Values.defaultBackend.name }}"
--
charts/nginx-ingress/templates/controller-rolebinding.yaml-  labels:
charts/nginx-ingress/templates/controller-rolebinding.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-rolebinding.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-servicemonitor.yaml-  labels:
charts/nginx-ingress/templates/controller-servicemonitor.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-servicemonitor.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-hpa.yaml-  labels:
charts/nginx-ingress/templates/controller-hpa.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-hpa.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/default-backend-service.yaml-  labels:
charts/nginx-ingress/templates/default-backend-service.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/default-backend-service.yaml-    component: "{{ .Values.defaultBackend.name }}"
--
charts/nginx-ingress/templates/controller-service.yaml-  labels:
charts/nginx-ingress/templates/controller-service.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-service.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-configmap-tcp.yaml-  labels:
charts/nginx-ingress/templates/controller-configmap-tcp.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-configmap-tcp.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-keda.yaml-  labels:
charts/nginx-ingress/templates/controller-keda.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-keda.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/clusterrolebinding.yaml-  labels:
charts/nginx-ingress/templates/clusterrolebinding.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/clusterrolebinding.yaml-    {{- include "ingress-nginx.labels" . | nindent 4 }}
--
charts/nginx-ingress/templates/controller-service-metrics.yaml-  labels:
charts/nginx-ingress/templates/controller-service-metrics.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-service-metrics.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-role.yaml-  labels:
charts/nginx-ingress/templates/controller-role.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-role.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-service-webhook.yaml-    component: "{{ .Values.controller.name }}"
charts/nginx-ingress/templates/controller-service-webhook.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-service-webhook.yaml-    {{- include "ingress-nginx.labels" . | nindent 4 }}
--
charts/nginx-ingress/templates/default-backend-poddisruptionbudget.yaml-  labels:
charts/nginx-ingress/templates/default-backend-poddisruptionbudget.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/default-backend-poddisruptionbudget.yaml-    component: "{{ .Values.defaultBackend.name }}"
--
charts/nginx-ingress/templates/controller-prometheusrules.yaml-  labels:
charts/nginx-ingress/templates/controller-prometheusrules.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-prometheusrules.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/default-backend-rolebinding.yaml-  labels:
charts/nginx-ingress/templates/default-backend-rolebinding.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/default-backend-rolebinding.yaml-    component: "{{ .Values.defaultBackend.name }}"
--
charts/certmanager-issuer/templates/_issuer.yaml-  labels:
charts/certmanager-issuer/templates/_issuer.yaml:{{- include "gitlab.standardLabels" . | nindent 4 }}
charts/certmanager-issuer/templates/_issuer.yaml-spec:
--
charts/nginx-ingress/templates/controller-psp.yaml-  labels:
charts/nginx-ingress/templates/controller-psp.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-psp.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-serviceaccount.yaml-  labels:
charts/nginx-ingress/templates/controller-serviceaccount.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-serviceaccount.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-configmap-addheaders.yaml-  labels:
charts/nginx-ingress/templates/controller-configmap-addheaders.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-configmap-addheaders.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-deployment.yaml-  labels:
charts/nginx-ingress/templates/controller-deployment.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-deployment.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/default-backend-hpa.yaml-  labels:
charts/nginx-ingress/templates/default-backend-hpa.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/default-backend-hpa.yaml-    component: "{{ .Values.defaultBackend.name }}"
--
charts/nginx-ingress/templates/controller-configmap.yaml-  labels:
charts/nginx-ingress/templates/controller-configmap.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-configmap.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-daemonset.yaml-  labels:
charts/nginx-ingress/templates/controller-daemonset.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-daemonset.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-configmap-proxyheaders.yaml-  labels:
charts/nginx-ingress/templates/controller-configmap-proxyheaders.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-configmap-proxyheaders.yaml-    component: "{{ .Values.controller.name }}"
--
charts/nginx-ingress/templates/controller-poddisruptionbudget.yaml-  labels:
charts/nginx-ingress/templates/controller-poddisruptionbudget.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/nginx-ingress/templates/controller-poddisruptionbudget.yaml-    component: "{{ .Values.controller.name }}"
--
charts/certmanager-issuer/templates/rbac-config.yaml-  labels:
charts/certmanager-issuer/templates/rbac-config.yaml:{{- include "gitlab.standardLabels" . | nindent 4 }}
charts/certmanager-issuer/templates/rbac-config.yaml-  annotations:
--
charts/certmanager-issuer/templates/cert-manager.yml-  labels:
charts/certmanager-issuer/templates/cert-manager.yml:{{- include "gitlab.standardLabels" . | nindent 4 }}
charts/certmanager-issuer/templates/cert-manager.yml-data:
--
charts/certmanager-issuer/templates/issuer-job.yaml-  labels:
charts/certmanager-issuer/templates/issuer-job.yaml:{{- include "gitlab.standardLabels" . | nindent 4 }}
charts/certmanager-issuer/templates/issuer-job.yaml-spec:
--
charts/gitlab/charts/operator/templates/deployment.yaml-  labels:
charts/gitlab/charts/operator/templates/deployment.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/gitlab/charts/operator/templates/deployment.yaml-  annotations:
--
charts/gitlab/charts/operator/templates/rbac.yaml-  labels:
charts/gitlab/charts/operator/templates/rbac.yaml:    {{- include "gitlab.standardLabels" $ | nindent 4 }}
charts/gitlab/charts/operator/templates/rbac.yaml----
--
charts/gitlab/charts/operator/templates/rbac.yaml-  labels:
charts/gitlab/charts/operator/templates/rbac.yaml:    {{- include "gitlab.standardLabels" $ | nindent 4 }}
charts/gitlab/charts/operator/templates/rbac.yaml-rules:
--
charts/gitlab/charts/operator/templates/rbac.yaml-  labels:
charts/gitlab/charts/operator/templates/rbac.yaml:    {{- include "gitlab.standardLabels" $ | nindent 4 }}
charts/gitlab/charts/operator/templates/rbac.yaml-roleRef:
--
charts/gitlab/charts/gitlab-grafana/templates/ingress.yaml-  labels:
charts/gitlab/charts/gitlab-grafana/templates/ingress.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/gitlab/charts/gitlab-grafana/templates/ingress.yaml-  annotations:
charts/gitlab/charts/operator/templates/gitlab.yaml-    gitlab.com/class: {{ .Release.Name }}
charts/gitlab/charts/operator/templates/gitlab.yaml:    {{- include "gitlab.standardLabels" $ | nindent 4 }}
charts/gitlab/charts/operator/templates/gitlab.yaml-  name: {{ template "fullname" . }}
--
charts/gitlab/charts/gitlab-grafana/templates/import-secret-configmap.yaml-  labels:
charts/gitlab/charts/gitlab-grafana/templates/import-secret-configmap.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/gitlab/charts/gitlab-grafana/templates/import-secret-configmap.yaml-data:
--
charts/gitlab/charts/gitlab-grafana/templates/datasource-configmap.yaml-    gitlab_grafana_datasource: "true"
charts/gitlab/charts/gitlab-grafana/templates/datasource-configmap.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/gitlab/charts/gitlab-grafana/templates/datasource-configmap.yaml-data:
--
charts/gitlab/charts/migrations/templates/configmap.yaml-  labels:
charts/gitlab/charts/migrations/templates/configmap.yaml:    {{- include "gitlab.standardLabels" . | nindent 4 }}
charts/gitlab/charts/migrations/templates/configmap.yaml-data:

Expected behavior

(What you're expecting to happen)

All objects that include 'gitlab.standardLabels' should include 'gitlab.commonLabels' directly after.

Edited May 25, 2021 by Mitchell Nielsen