Support Hugo shortcode comment style

This will allow to drop the "autogenerated" comment when rendering the metrics reference as a Hugo docs page. Requested here: cilium/tetragon#2164 (comment) Signed-off-by: Anna Kapuscinska <[email protected]>
isovalent · Mar 1, 2024 · 540a7a9 · 540a7a9
1 parent 71b3906
commit 540a7a9
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/pkg/metricsmd/config.go b/pkg/metricsmd/config.go
@@ -9,6 +9,12 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 )
 
+const (
+	HugoShortcodeCommentStyle CommentStyle = "hugo-shortcode"
+)
+
+type CommentStyle string
+
 type LabelValues struct {
 	Label  string
 	Values []string
@@ -24,4 +30,5 @@ type Config struct {
 	Targets          map[string]string // cli argument -> docs header
 	LabelOverrides   []LabelOverrides
 	InitMetrics      func(target string, reg *prometheus.Registry, log *slog.Logger) error
+	CommentStyle     CommentStyle
 }
diff --git a/pkg/metricsmd/print.go b/pkg/metricsmd/print.go
@@ -46,7 +46,15 @@ func NewCmd(vp *viper.Viper, log *slog.Logger, config *Config) *cobra.Command {
 
 			var b bytes.Buffer
 			// Comment to inform people this file is autogenerated.
-			b.WriteString("<!-- This file is autogenerated via https://github.com/isovalent/metricstool -->\n\n")
+			switch config.CommentStyle {
+			case HugoShortcodeCommentStyle:
+				b.WriteString(`{{< comment >}}
+This page is autogenerated via https://github.com/isovalent/metricstool,
+please do not edit directly.
+{{< /comment >}}`)
+			default:
+				b.WriteString("<!-- This file is autogenerated via https://github.com/isovalent/metricstool -->\n\n")
+			}
 			// Document title
 			b.WriteString(fmt.Sprintf("# %s Metrics\n\n", config.Targets[target]))
 			// Generate metrics reference