chore(ci): update script to generate Artifacthub annotations

The kubernetes version limitation is incompatible with the custom AWS EKS
version pattern. For this reason, some AWS EKS installation needs to adapt the
Chart manually to get it running. To avoid this circumstance, the kubernetes
version limitation has been removed.

.gitea/scripts/add-annotations.sh

@@ -0,0 +1,110 @@
+#!/bin/bash
+
+set -e
+
+CHART_FILE="Chart.yaml"
+if [ ! -f "${CHART_FILE}" ]; then
+  echo "ERROR: ${CHART_FILE} not found!" 1>&2
+  exit 1
+fi
+
+DEFAULT_NEW_TAG="$(git tag --sort=-version:refname | head -n 1)"
+DEFAULT_OLD_TAG="$(git tag --sort=-version:refname | head -n 2 | tail -n 1)"
+
+if [ -z "${1}" ]; then
+  read -p "Enter start tag [${DEFAULT_OLD_TAG}]: " OLD_TAG
+  if [ -z "${OLD_TAG}" ]; then
+    OLD_TAG="${DEFAULT_OLD_TAG}"
+  fi
+
+  while [ -z "$(git tag --list "${OLD_TAG}")" ]; do
+    echo "ERROR: Tag '${OLD_TAG}' not found!" 1>&2
+    read -p "Enter start tag [${DEFAULT_OLD_TAG}]: " OLD_TAG
+    if [ -z "${OLD_TAG}" ]; then
+      OLD_TAG="${DEFAULT_OLD_TAG}"
+    fi
+  done
+else
+  OLD_TAG=${1}
+  if [ -z "$(git tag --list "${OLD_TAG}")" ]; then
+    echo "ERROR: Tag '${OLD_TAG}' not found!" 1>&2
+    exit 1
+  fi
+fi
+
+if [ -z "${2}" ]; then
+  read -p "Enter end tag [${DEFAULT_NEW_TAG}]: " NEW_TAG
+  if [ -z "${NEW_TAG}" ]; then
+    NEW_TAG="${DEFAULT_NEW_TAG}"
+  fi
+
+  while [ -z "$(git tag --list "${NEW_TAG}")" ]; do
+    echo "ERROR: Tag '${NEW_TAG}' not found!" 1>&2
+    read -p "Enter end tag [${DEFAULT_NEW_TAG}]: " NEW_TAG
+    if [ -z "${NEW_TAG}" ]; then
+      NEW_TAG="${DEFAULT_NEW_TAG}"
+    fi
+  done
+else
+  NEW_TAG=${2}
+
+  if [ -z "$(git tag --list "${NEW_TAG}")" ]; then
+    echo "ERROR: Tag '${NEW_TAG}' not found!" 1>&2
+    exit 1
+  fi
+fi
+
+YAML_FILE=$(mktemp)
+
+function map_type_to_kind() {
+  case "${1}" in
+    feat)
+      echo "added"
+    ;;
+    fix)
+      echo "fixed"
+    ;;
+    chore|style|test|ci|docs|refac)
+      echo "changed"
+    ;;
+    revert)
+      echo "removed"
+    ;;
+    sec)
+      echo "security"
+    ;;
+    *)
+      echo "skip"
+    ;;
+  esac
+}
+
+COMMIT_TITLES="$(git log --pretty=format:"%s" "${OLD_TAG}..${NEW_TAG}")"
+
+echo "INFO: Generate change log entries from ${OLD_TAG} until ${NEW_TAG}"
+
+while IFS= read -r line; do
+  if [[ "${line}" =~ ^([a-zA-Z]+)(\([^\)]+\))?\:\ (.+)$ ]]; then
+    TYPE="${BASH_REMATCH[1]}"
+
+    if [ "${TYPE}" == "skip" ]; then
+      continue
+    fi
+
+    DESC="${BASH_REMATCH[3]}"
+    KIND=$(map_type_to_kind "${TYPE}")
+
+    echo "- ${KIND}: ${DESC}"
+
+    yq --inplace ". += [ {\"kind\": \"${KIND}\", \"description\": \"${DESC}\"}]" "${YAML_FILE}"
+  fi
+done <<< "${COMMIT_TITLES}"
+
+if [ -s "${YAML_FILE}" ]; then
+  yq --no-colors --inplace ".annotations.\"artifacthub.io/changes\" |= loadstr(\"${YAML_FILE}\") | sort_keys(.)" "${CHART_FILE}"
+else
+  echo "ERROR: Changelog file is empty: ${YAML_FILE}" 1>&2
+  exit 1
+fi
+
+rm "${YAML_FILE}"

.gitea/workflows/helm.yaml

@@ -13,7 +13,7 @@ on:
 jobs:
   helm-lint:
     container:
-      image: docker.io/volkerraschek/helm:3.18.0
+      image: docker.io/volkerraschek/helm:3.18.2
     runs-on:
     - ubuntu-latest
     steps:
@@ -28,7 +28,7 @@ jobs:
 
   helm-unittest:
     container:
-      image: docker.io/volkerraschek/helm:3.18.0
+      image: docker.io/volkerraschek/helm:3.18.2
     runs-on:
     - ubuntu-latest
     steps:

.gitea/workflows/release.yaml

@@ -8,18 +8,26 @@ on:
 jobs:
   publish-chart:
     container:
-      image: docker.io/volkerraschek/helm:3.18.0
+      image: docker.io/volkerraschek/helm:3.18.2
     runs-on: ubuntu-latest
     steps:
       - name: Install tooling
         run: |
           apk update
-          apk add git npm
+          apk add git npm yq
+
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Add Artifacthub.io annotations
+        run: |
+          NEW_TAG="$(git tag --sort=-version:refname | head -n 1)"
+          OLD_TAG="$(git tag --sort=-version:refname | head -n 2 | tail -n 1)"
+          .gitea/scripts/add-annotations.sh "${OLD_TAG}" "${NEW_TAG}"
+
       - name: Package chart
         env:
-          HELM_REPO_NAME: upload
-
           CHARTMUSEUM_PASSWORD: ${{ secrets.CHARTMUSEUM_PASSWORD }}
           CHARTMUSEUM_REPOSITORY: ${{ vars.CHARTMUSEUM_REPOSITORY }}
           CHARTMUSEUM_USERNAME: ${{ secrets.CHARTMUSEUM_USERNAME }}

Chart.yaml

@@ -1,8 +1,13 @@
+annotations:
+  artifacthub.io/links: |
+    - name: Prometheus PostgreSQL exporter (binary)
+      url: https://github.com/prometheus-community/postgres_exporter
+    - name: support
+      url: https://git.cryptic.systems/volker.raschek/prometheus-postgres-exporter/issues
 apiVersion: v2
 name: prometheus-postgres-exporter
 description: Prometheus metric exporter for PostgreSQL
 type: application
-kubeVersion: ">=1.20.0"
 version: "0.1.0"
 appVersion: "0.17.1"
 

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Markus Pesch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -4,7 +4,7 @@ CONTAINER_RUNTIME?=$(shell which podman)
 # HELM_IMAGE
 HELM_IMAGE_REGISTRY_HOST?=docker.io
 HELM_IMAGE_REPOSITORY?=volkerraschek/helm
-HELM_IMAGE_VERSION?=3.18.0 # renovate: datasource=docker registryUrl=https://docker.io depName=volkerraschek/helm
+HELM_IMAGE_VERSION?=3.18.2 # renovate: datasource=docker registryUrl=https://docker.io depName=volkerraschek/helm
 HELM_IMAGE_FULLY_QUALIFIED=${HELM_IMAGE_REGISTRY_HOST}/${HELM_IMAGE_REPOSITORY}:${HELM_IMAGE_VERSION}
 
 # NODE_IMAGE

README.md

@@ -47,7 +47,7 @@ version of the chart must be in sync with the `values.yaml`. Newer *minor* versi
 versions can break something!
 
 ```bash
-CHART_VERSION=0.4.2
+CHART_VERSION=0.5.1
 helm show values prometheus-exporters/prometheus-postgres-exporter --version "${CHART_VERSION}" > values.yaml
 ```
 

templates/prometheus-postgres-exporter/_deployment.tpl

@@ -7,37 +7,6 @@
 {{- if .Values.deployment.annotations }}
 {{ toYaml .Values.deployment.annotations }}
 {{- end }}
-
-# The following annotations are required to trigger a rolling update. Further information can be found in the official
-# documentation of helm:
-#
-#   https://helm.sh/docs/howto/charts_tips_and_tricks/#automatically-roll-deployments
-#
-
-{{/* database */}}
-{{- if and .Values.config.database.existingSecret.enabled .Values.config.database.existingSecret.secretName }}
-{{- $secret := default (dict "data" (dict)) (lookup "v1" "Secret" .Release.Namespace .Values.config.database.existingSecret.secretName ) }}
-checksum/secret-database: {{ print $secret.spec | sha256sum }}
-{{- else }}
-checksum/secret-database: {{ include (print $.Template.BasePath "/prometheus-postgres-exporter/secretDatabase.yaml") . | sha256sum }}
-{{- end }}
-
-{{/* exporter config */}}
-{{- if and .Values.config.exporterConfig.existingSecret.enabled .Values.config.exporterConfig.existingSecret.secretName }}
-{{- $secret := default (dict "data" (dict)) (lookup "v1" "Secret" .Release.Namespace .Values.config.exporterConfig.existingSecret.secretName ) }}
-checksum/secret-exporter-config: {{ print $secret.spec | sha256sum }}
-{{- else }}
-checksum/secret-exporter-config: {{ include (print $.Template.BasePath "/prometheus-postgres-exporter/secretExporterConfig.yaml") . | sha256sum }}
-{{- end }}
-
-{{/* web config */}}
-{{- if and .Values.config.webConfig.existingSecret.enabled .Values.config.webConfig.existingSecret.secretName }}
-{{- $secret := default (dict "data" (dict)) (lookup "v1" "Secret" .Release.Namespace .Values.config.webConfig.existingSecret.secretName ) }}
-checksum/secret-web-config: {{ print $secret.spec | sha256sum }}
-{{- else }}
-checksum/secret-web-config: {{ include (print $.Template.BasePath "/prometheus-postgres-exporter/secretWebConfig.yaml") . | sha256sum }}
-{{- end }}
-
 {{- end }}
 
 {{/* env */}}

templates/prometheus-postgres-exporter/_pod.tpl

@@ -4,6 +4,37 @@
 
 {{- define "prometheus-postgres-exporter.pod.annotations" -}}
 {{ include "prometheus-postgres-exporter.annotations" . }}
+
+# The following annotations are required to trigger a rolling update. Further information can be found in the official
+# documentation of helm:
+#
+#   https://helm.sh/docs/howto/charts_tips_and_tricks/#automatically-roll-deployments
+#
+
+{{/* database */}}
+{{- if and .Values.config.database.existingSecret.enabled .Values.config.database.existingSecret.secretName }}
+{{- $secret := default (dict "data" (dict)) (lookup "v1" "Secret" .Release.Namespace .Values.config.database.existingSecret.secretName ) }}
+checksum/secret-database: {{ print $secret.spec | sha256sum }}
+{{- else }}
+checksum/secret-database: {{ include (print $.Template.BasePath "/prometheus-postgres-exporter/secretDatabase.yaml") . | sha256sum }}
+{{- end }}
+
+{{/* exporter config */}}
+{{- if and .Values.config.exporterConfig.existingSecret.enabled .Values.config.exporterConfig.existingSecret.secretName }}
+{{- $secret := default (dict "data" (dict)) (lookup "v1" "Secret" .Release.Namespace .Values.config.exporterConfig.existingSecret.secretName ) }}
+checksum/secret-exporter-config: {{ print $secret.spec | sha256sum }}
+{{- else }}
+checksum/secret-exporter-config: {{ include (print $.Template.BasePath "/prometheus-postgres-exporter/secretExporterConfig.yaml") . | sha256sum }}
+{{- end }}
+
+{{/* web config */}}
+{{- if and .Values.config.webConfig.existingSecret.enabled .Values.config.webConfig.existingSecret.secretName }}
+{{- $secret := default (dict "data" (dict)) (lookup "v1" "Secret" .Release.Namespace .Values.config.webConfig.existingSecret.secretName ) }}
+checksum/secret-web-config: {{ print $secret.spec | sha256sum }}
+{{- else }}
+checksum/secret-web-config: {{ include (print $.Template.BasePath "/prometheus-postgres-exporter/secretWebConfig.yaml") . | sha256sum }}
+{{- end }}
+
 {{- end }}
 
 {{/* labels */}}

templates/prometheus-postgres-exporter/deployment.yaml

@@ -18,6 +18,8 @@ spec:
       {{- include "prometheus-postgres-exporter.pod.selectorLabels" . | nindent 6 }}
   template:
     metadata:
+      annotations:
+        {{- include "prometheus-postgres-exporter.pod.annotations" . | nindent 8 }}
       labels:
         {{- include "prometheus-postgres-exporter.pod.labels" . | nindent 8 }}
     spec:

unittests/deployment/deployment.yaml

@@ -27,14 +27,8 @@ tests:
       name: prometheus-postgres-exporter-unittest
       namespace: testing
     template: templates/prometheus-postgres-exporter/deployment.yaml
-  - exists:
-      path: metadata.annotations.checksum/secret-database
-    template: templates/prometheus-postgres-exporter/deployment.yaml
-  - exists:
-      path: metadata.annotations.checksum/secret-exporter-config
-    template: templates/prometheus-postgres-exporter/deployment.yaml
-  - exists:
-      path: metadata.annotations.checksum/secret-web-config
+  - notExists:
+      path: metadata.annotations
     template: templates/prometheus-postgres-exporter/deployment.yaml
   - equal:
       path: metadata.labels
@@ -49,6 +43,24 @@ tests:
       path: spec.replicas
       value: 1
     template: templates/prometheus-postgres-exporter/deployment.yaml
+  - exists:
+      path: spec.template.metadata.annotations.checksum/secret-database
+    template: templates/prometheus-postgres-exporter/deployment.yaml
+  - exists:
+      path: spec.template.metadata.annotations.checksum/secret-exporter-config
+    template: templates/prometheus-postgres-exporter/deployment.yaml
+  - exists:
+      path: spec.template.metadata.annotations.checksum/secret-web-config
+    template: templates/prometheus-postgres-exporter/deployment.yaml
+  - equal:
+      path: spec.template.metadata.labels
+      value:
+        app.kubernetes.io/instance: prometheus-postgres-exporter-unittest
+        app.kubernetes.io/managed-by: Helm
+        app.kubernetes.io/name: prometheus-postgres-exporter
+        app.kubernetes.io/version: 0.1.0
+        helm.sh/chart: prometheus-postgres-exporter-0.1.0
+    template: templates/prometheus-postgres-exporter/deployment.yaml
   - notExists:
       path: spec.template.spec.affinity
     template: templates/prometheus-postgres-exporter/deployment.yaml