generate changelogs for use by chart releaser

.github/CHANGELOG.md.gotmpl

@@ -0,0 +1,15 @@
+{{ $chart := (ds "chart") -}}
+{{ $changes := (ds "changes") -}}
+# {{ $chart.name }} Changelog
+
+## {{ $chart.version }}
+
+{{- range $kind := $changes }}
+
+### {{ $kind.key | strings.Title }}
+
+{{- range $change := $kind.value }}
+- {{ $change.description }}
+{{- end }}
+
+{{- end }}

.github/ct/ct.yaml

@@ -13,3 +13,4 @@ skip-missing-values: true
 release-label: release
 chart-repos:
   - bitnami=https://charts.bitnami.com/bitnami
+release-notes-file: CHANGELOG.md

.github/generate-chart-changelogs.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -euo pipefail
+
+CHART_DIR=charts
+
+for dir in "$CHART_DIR"/*; do
+    if test ! -f "${dir}/Chart.yaml"; then
+        echo "Skipping over ${dir}"
+        continue
+    fi
+
+    CHART_NAME=$(basename "$dir")
+
+    echo "Creating CHANGELOG.md for ${CHART_NAME}"
+
+    cat "$dir/Chart.yaml" |
+        yq e '.annotations["artifacthub.io/changes"]' - |                                                 # extract the changes annotation, which is a YAML array
+        yq -o json e '.' - |                                                                              # convert the YAML array to a JSON array
+        jq 'group_by(.kind) | to_entries | map({key: .value[0].kind, value: .value})' - |                 # group the JSON array by their 'kind' - ie. the type of change
+        gomplate -d chart="$dir/Chart.yaml" -d changes=stdin:///in.json -f .github/CHANGELOG.md.gotmpl >"$dir/CHANGELOG.md" # use the JSON above as input to render the changelog
+
+done

.github/workflows/ci.yaml

@@ -22,20 +22,29 @@ jobs:
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
+
       - name: Check if documentation is up-to-date
-        run: bash generate-docs.sh && git diff --exit-code HEAD
+        run: generate-docs.sh && git diff --exit-code HEAD
+
       - name: Update dependencies
         run: find charts/ ! -path charts/ -maxdepth 1 -type d -exec helm dependency update {} \;
+
       - name: Run YAML lint
         run: yamllint .
+
       - name: Run chart-testing (lint)
         run: ct lint --config .github/ct/ct.yaml
+
       - name: Run Powerlint
         env:
           # Don't support 1.22 yet since we can't explicitely pass a a Kubernetes version number to
           # `helm template`
           KUBERNETES_VERSIONS: "1.18.0 1.19.0 1.20.0 1.21.0"
-        run: bash chart-powerlint.sh
+        run: chart-powerlint.sh
+
+      # used to test whether the changelog generation process works properly
+      - name: Generate changelogs (test)
+        run: .github/generate-chart-changelogs.sh
 
   test:
     runs-on: ubuntu-20.04
@@ -47,11 +56,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up Helm
-        uses: azure/setup-helm@v1
-        with:
-          version: v3.5.2
-
       - uses: actions/setup-python@v2
         with:
           python-version: 3.9

.github/workflows/release.yaml

@@ -21,20 +21,19 @@ jobs:
           git config user.name "$GITHUB_ACTOR"
           git config user.email "[email protected]"
 
-      - name: Install Helm
-        uses: azure/setup-helm@v1
-        with:
-          version: v3.4.0
-
       - name: Add bitnami repo
         run: helm repo add bitnami https://charts.bitnami.com/bitnami
 
       - name: Update dependencies
         run: find charts/ ! -path charts/ -maxdepth 1 -type d -exec helm dependency update {} \;
 
+      - name: Generate changelogs
+        run: .github/generate-chart-changelogs.sh
+
       - name: Run chart-releaser
         uses: helm/[email protected]
         with:
           config: .github/ct/ct.yaml
+          version: 1.3.0
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

charts/fhir-server-exporter/Chart.yaml

@@ -12,5 +12,5 @@ annotations:
     # When using the list of objects option the valid supported kinds are
     # added, changed, deprecated, removed, fixed and security.
     - kind: changed
-      description: updated exporter to latest version
-version: 0.3.1
+      description: version bump to test changelog generation
+version: 0.3.2

charts/fhir-server/Chart.yaml

@@ -10,4 +10,10 @@ maintainers:
 sources:
   - https://github.com/microsoft/fhir-server
 type: application
-version: 0.5.12
+annotations:
+  artifacthub.io/changes: |
+    # When using the list of objects option the valid supported kinds are added,
+    # changed, deprecated, removed, fixed and security.
+    - kind: changed
+      description: version bump to test changelog generation
+version: 0.5.13

charts/ohdsi/Chart.yaml

@@ -18,12 +18,11 @@ dependencies:
     version: 10.12.7
     repository: https://charts.bitnami.com/bitnami
     condition: postgresql.enabled
+appVersion: 2.10.0
 annotations:
   artifacthub.io/changes: |
     # When using the list of objects option the valid supported kinds are added,
     # changed, deprecated, removed, fixed and security.
     - kind: changed
-      description: |
-        updated WebAPI and Atlas to v2.10.0
-version: 0.7.3
-appVersion: 2.10.0
+      description: version bump to test changelog generation
+version: 0.7.4