[Bot] Add automatically generated go documentation

Author: Tofel

folders.json

@@ -0,0 +1,68 @@
+[
+  {
+    "folder": "framework"
+  },
+  {
+    "folder": "framework/examples/myproject"
+  },
+  {
+    "folder": "framework/examples/myproject_cll"
+  },
+  {
+    "folder": "havoc"
+  },
+  {
+    "folder": "k8s-test-runner"
+  },
+  {
+    "folder": "lib"
+  },
+  {
+    "folder": "lib/grafana"
+  },
+  {
+    "folder": "seth"
+  },
+  {
+    "folder": "seth/examples_wasp"
+  },
+  {
+    "folder": "tools/asciitable"
+  },
+  {
+    "folder": "tools/breakingchanges"
+  },
+  {
+    "folder": "tools/citool"
+  },
+  {
+    "folder": "tools/ecrimagefetcher"
+  },
+  {
+    "folder": "tools/envresolve"
+  },
+  {
+    "folder": "tools/flakeguard"
+  },
+  {
+    "folder": "tools/ghlatestreleasechecker"
+  },
+  {
+    "folder": "tools/ghsecrets"
+  },
+  {
+    "folder": "tools/gotestloghelper"
+  },
+  {
+    "folder": "tools/testlistgenerator"
+  },
+  {
+    "folder": "tools/workflowresultparser"
+  },
+  {
+    "folder": "wasp"
+  },
+  {
+    "folder": "wasp/examples"
+  }
+]

seth/config.go

@@ -15,6 +15,8 @@ import (
 	"github.com/pkg/errors"
 )
 
+// MyAmazingNewFunction returns a predefined string value. 
+// It can be used as a placeholder or for testing purposes in various contexts.
 func MyAmazingNewFunction() string {
 	return "bla bla bla"
 }

tools/flakeguard/reports/reports.go

@@ -188,12 +188,15 @@ func AggregateTestResults(folderPath string) (*TestReport, error) {
 	return fullReport, nil
 }
 
-// PrintTests prints tests in a pretty format
-func PrintTests(
-	w io.Writer,
-	tests []TestResult,
-	maxPassRatio float64,
-) (runs, passes, fails, skips, panickedTests, racedTests, flakyTests int) {
+// TestResultsTable generates a formatted table of test results, filtering by a specified pass ratio.
+// It returns the table along with counts of runs, passes, failures, skips, and various test states.
+// This function is useful for summarizing and analyzing test outcomes in a structured format.
+func TestResultsTable(
+	results []TestResult,
+	expectedPassRatio float64,
+	includeCodeOwners bool,
+	markdown bool,
+) (resultsTable [][]string, runs, passes, fails, skips, panickedTests, racedTests, flakyTests int) {
 	p := message.NewPrinter(language.English) // For formatting numbers
 	sortTestResults(tests)