[Bot] Add automatically generated go documentation

smartcontractkit · Dec 9, 2024 · 153cbec · 153cbec
1 parent 376893f
commit 153cbec
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 73 deletions.
diff --git a/all_folders.json b/all_folders.json
diff --git a/filtered_folders.json b/filtered_folders.json
diff --git a/tools/flakeguard/reports/io.go b/tools/flakeguard/reports/io.go
@@ -101,6 +101,9 @@ func SaveReportNoLogs(fs FileSystem, filePath string, report TestReport) error {
 	return fs.WriteFile(filePath, data, 0644)
 }
 
+// SaveReport saves a TestReport to a specified file path in JSON format.
+// It ensures the file is created or truncated and handles any errors during
+// file operations, providing a reliable way to persist test results.
 func SaveReport(fs FileSystem, filePath string, report TestReport) error {
 	// Open the file with truncation mode
 	file, err := os.OpenFile(filePath, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)