Merge pull request #73831 from aireilly/update-template

Tweaking Vale template to add links

Author: aireilly

.vale/templates/bot-comment-output.tmpl

@@ -7,43 +7,42 @@
 {{- $s := 0 -}}
 
 {{- /* Range over the linted files */ -}}
-
 [
 {{- range $jdx, $file := .Files -}}
-
-{{- $path := .Path -}}
-
-{{- /* Range over the file's alerts */ -}}
-
-{{- if $jdx -}},{{- end -}}
-{{- range $idx, $a := .Alerts -}}
-
-{{- $error := "" -}}
-{{- if eq .Severity "error" -}}
-    {{- $error = "error" -}}
-    {{- $e = add1 $e  -}}
-{{- else if eq .Severity "warning" -}}
-    {{- $error = "warning" -}}
-    {{- $w = add1 $w -}}
-{{- else -}}
-    {{- $error = "suggestion" -}}
-    {{- $s = add1 $s -}}
-{{- end}}
-
-{{- /* Variables setup */ -}}
-
-{{- $loc := printf "%d" .Line -}}
-{{- $check := printf "%s" .Check -}}
-{{- $message := printf "%s" .Message -}}
-{{- if $idx -}},{{- end -}}
-
-{{- /* Output */ -}}
-
-  {
-    "body": "🤖 **[{{ $error }}] {{$check}}**: {{ $message }}",
-    "path": "{{ $path }}",
-    "line": {{ $loc }}
-  }
-{{end -}}
+    {{- $path := .Path -}}
+    {{- /* Range over the file's alerts */ -}}
+    {{- if $jdx -}},{{- end -}}
+    {{- range $idx, $a := .Alerts -}}
+
+        {{- $error := "" -}}
+        {{- if eq .Severity "error" -}}
+            {{- $error = "error" -}}
+            {{- $e = add1 $e  -}}
+        {{- else if eq .Severity "warning" -}}
+            {{- $error = "warning" -}}
+            {{- $w = add1 $w -}}
+        {{- else -}}
+            {{- $error = "suggestion" -}}
+            {{- $s = add1 $s -}}
+        {{- end}}
+
+        {{- /* Variables setup */ -}}
+        {{- $loc := printf "%d" .Line -}}
+        {{- $check := printf "%s" .Check -}}
+        {{- $message := printf "%s" .Message -}}
+        {{- /* Only add a link for RedHat rule errors */ -}}
+        {{- $link := "" -}}
+        {{- if contains "RedHat." .Check -}}
+            {{- $link = printf "For more information, see [%s](https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/%s)." .Check (lower (trimPrefix "RedHat." .Check)) -}}
+        {{- end -}}
+        {{- if $idx -}},{{- end -}}
+
+        {{- /* Output */ -}}
+        {
+            "body": "🤖 **[{{ $error }}] {{$check}}**: {{ $message }} {{ $link }}",
+            "path": "{{ $path }}",
+            "line": {{ $loc }}
+        }
+    {{end -}}
 {{end -}}
 ]