Don't add "autogenerate" comment by default

Having such a comment in the final docs HTML might be undesirable, and this is the case e.g. when the markdown is rendered with Hugo. Additionally, if metrics from multiple targets are compiled into one reference file, then it would include redundant comments. The "autogenerated" comment can still be enabled with a config option. Signed-off-by: Anna Kapuscinska <[email protected]>
isovalent · Mar 1, 2024 · 7f0ee42 · 7f0ee42
1 parent bdb31b4
commit 7f0ee42
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/pkg/metricsmd/config.go b/pkg/metricsmd/config.go
@@ -20,8 +20,9 @@ type LabelOverrides struct {
 }
 
 type Config struct {
-	CobraAnnotations map[string]string
-	Targets          map[string]string // cli argument -> docs header
-	LabelOverrides   []LabelOverrides
-	InitMetrics      func(target string, reg *prometheus.Registry, log *slog.Logger) error
+	CobraAnnotations     map[string]string
+	Targets              map[string]string // cli argument -> docs header
+	LabelOverrides       []LabelOverrides
+	InitMetrics          func(target string, reg *prometheus.Registry, log *slog.Logger) error
+	AutogeneratedComment bool
 }
diff --git a/pkg/metricsmd/print.go b/pkg/metricsmd/print.go
@@ -45,8 +45,10 @@ 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")
+			if config.AutogeneratedComment {
+				// Comment to inform people this file is autogenerated.
+				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