Merge pull request #644 from cloudflare/issue-608

Add list of problems to gh report summary

.github/workflows/benchmark.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.20.3
+          go-version: 1.20.5
           cache: true
 
       - name: Test

.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.20.3
+          go-version: 1.20.5
           cache: true
 
       - name: Compile pint

.github/workflows/compile.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.20.3
+          go-version: 1.20.5
           cache: true
 
       - name: Set up QEMU

.github/workflows/examples.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.20.3
+          go-version: 1.20.5
           cache: true
 
       - name: Build binary

.github/workflows/go-mod-tidy.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.20.3
+          go-version: 1.20.5
 
       - name: Run go mod tidy
         run: go mod tidy

.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.20.3
+          go-version: 1.20.5
           cache: true
           cache-dependency-path: tools/golangci-lint/go.sum
 
@@ -34,7 +34,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.20.3
+          go-version: 1.20.5
           cache: true
           cache-dependency-path: tools/gofumpt/go.sum
 

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: 1.20.3
+          go-version: 1.20.5
           cache: true
 
       - name: Test

docs/changelog.md

@@ -9,6 +9,8 @@
   This allows to only show estimated alerts count only if there would be high
   enough (`>= minCount`) number of alerts.
   Setting `severity` as well allows to block rules that would create too many alerts.
+- GitHub reporter will now included folded list of all problems in the summary
+  comment - #608.
 
 ### Fixed
 

internal/reporter/github.go

@@ -1,6 +1,7 @@
 package reporter
 
 import (
+	"bytes"
 	"context"
 	"fmt"
 	"strconv"
@@ -251,6 +252,23 @@ func formatGHReviewBody(version string, summary Summary) string {
 
 	b.WriteString("\n</p>\n</details>\n\n")
 
+	b.WriteString("<details><summary>Problems</summary>\n<p>\n\n")
+	if summary.Entries > 0 {
+		buf := bytes.NewBuffer(nil)
+		cr := NewConsoleReporter(buf, checks.Information)
+		err := cr.Submit(summary)
+		if err != nil {
+			b.WriteString(fmt.Sprintf("Failed to generate list of problems: %s", err))
+		} else {
+			b.WriteString("```\n")
+			b.WriteString(buf.String())
+			b.WriteString("```\n")
+		}
+	} else {
+		b.WriteString("No problems reported")
+	}
+	b.WriteString("\n</p>\n</details>\n\n")
+
 	return b.String()
 }