adjust sarif for github (#27)

boostsecurityio · Apr 15, 2024 · 9cd49ec · 9cd49ec
1 parent dd8c68f
commit 9cd49ec
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/formatters/sarif/sarif.go b/formatters/sarif/sarif.go
@@ -73,16 +73,17 @@ func (f *Format) Format(ctx context.Context, report *opa.FindingsResult, package
 				line = 1
 			}
 			ruleDoc := docs[ruleId]
+			ruleUrl := fmt.Sprintf("https://github.com/boostsecurityio/poutine/tree/main/docs/content/en/rules/%s.md", ruleId)
 
 			run.AddRule(ruleId).
 				WithName(rule.Title).
 				WithDescription(rule.Title).
 				WithFullDescription(
-					sarif.NewMarkdownMultiformatMessageString(ruleDoc),
+					sarif.NewMultiformatMessageString(ruleDescription),
 				).
-				WithHelpURI(
-					fmt.Sprintf("https://github.com/boostsecurityio/poutine/tree/main/docs/content/en/rules/%s.md", ruleId),
-				)
+				WithHelpURI(ruleUrl).
+				WithTextHelp(ruleUrl).
+				WithMarkdownHelp(ruleDoc)
 
 			run.AddDistinctArtifact(path)