feat(helm): Hint for correct "artifacthub.io/changes" syntax (#13397)

Author: kiblik

.github/workflows/test-helm-chart.yml

@@ -79,7 +79,7 @@ jobs:
           target_annotation=$(git show "${{ env.ct-branch }}:helm/defectdojo/Chart.yaml" | yq e '.annotations."artifacthub.io/changes"' -)
 
           if [[ "$current_annotation" == "$target_annotation" ]]; then
-            echo "::error file=helm/defectdojo/Chart.yaml::The 'artifacthub.io/changes' annotation has not been updated compared to ${{ env.ct-branch }}"
+            echo "::error file=helm/defectdojo/Chart.yaml::The 'artifacthub.io/changes' annotation has not been updated compared to ${{ env.ct-branch }}. For more, check the hint in 'helm/defectdojo/Chart.yaml'"
             exit 1
           fi
 

helm/defectdojo/Chart.yaml

@@ -18,5 +18,20 @@ dependencies:
     repository: "oci://us-docker.pkg.dev/os-public-container-registry/defectdojo"
     condition: redis.enabled
 annotations:
+  # For correct syntax, check https://artifacthub.io/docs/topics/annotations/helm/
+  # This is example for "artifacthub.io/changes"
+  # artifacthub.io/changes: |
+  #   - kind: added
+  #     description: Cool feature
+  #   - kind: fixed
+  #     description: Minor bug
+  #   - kind: changed
+  #     description: Broken feature
+  #   - kind: removed
+  #     description: Old bug
+  #   - kind: deprecated
+  #     description: Not-needed feature
+  #   - kind: security
+  #     description: Critical bug
   artifacthub.io/prerelease: "true"
   artifacthub.io/changes: ""