From 6e2db9859060967f71b2a77eb6acf7dc254788e3 Mon Sep 17 00:00:00 2001
From: Samuel Berthe <dev@samuel-berthe.fr>
Date: Wed, 5 Nov 2025 17:04:30 +0100
Subject: [PATCH] feat: add support for exporter-level comments (#481)

---
 dist/template.yml | 6 +++++-
 rules.md          | 1 +
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/dist/template.yml b/dist/template.yml
index cdde4ea..5c991cb 100644
--- a/dist/template.yml
+++ b/dist/template.yml
@@ -2,9 +2,13 @@ groups:
 {% assign groupName = slug | split: '-' %}{% capture groupNameCamelcase %}{% for word in groupName %}{{ word | capitalize }} {% endfor %}{% endcapture %}
 - name: {{ groupNameCamelcase | remove: ' ' | remove: '-' }}
 
+  {% assign lines = comments | split: "
+" %}{% for line in lines %}# {{ line | strip }}
+  {% endfor %}
   rules:
 {% for rule in rules %}{% assign ruleName = rule.name | split: ' ' %}{% capture ruleNameCamelcase %}{% for word in ruleName %}{{ word | capitalize }} {% endfor %}{% endcapture %}
-    {% for comment in comments %}# {{ comment | strip }}
+    {% assign lines = rule.comments | split: "
+" %}{% for line in lines %}# {{ line | strip }}
     {% endfor %}- alert: {{ ruleNameCamelcase | remove: ' ' }}
       expr: '{{ rule.query }}'
       for: {% if rule.for %}{{ rule.for }}{% else %}0m{% endif %}
diff --git a/rules.md b/rules.md
index f786f81..02364e5 100644
--- a/rules.md
+++ b/rules.md
@@ -62,6 +62,7 @@
 // @TODO: Please contribute => https://github.com/samber/awesome-prometheus-alerts 👋
 {% endhighlight %}
         {% else %}
+{{ exporter.comments | strip | newline_to_br }}
 {% highlight bash %}
 $ wget https://raw.githubusercontent.com/samber/awesome-prometheus-alerts/master/dist/rules/{{ service.name | replace: " ", "-" | downcase }}/{{ exporter.slug }}.yml
 {% endhighlight %}