add instructions to fix header issues in markdown comment (#179)

apache · Mar 28, 2024 · 9753868 · 9753868
1 parent e6d1ce4
commit 9753868
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/pkg/review/header.go b/pkg/review/header.go
@@ -257,11 +257,10 @@ func IsPR() bool {
 	return os.Getenv("GITHUB_EVENT_NAME") == "pull_request"
 }
 
-// TODO add fixing guide
 func Markdown(result *header2.Result) string {
 	return fmt.Sprintf(`
 <!-- %s -->
-[license-eye](https://github.com/apache/skywalking-eyes/tree/main/cmd/license-eye) has totally checked %d files.
+[license-eye](https://github.com/apache/skywalking-eyes/tree/main/cmd/license-eye) has checked %d files.
 | Valid | Invalid | Ignored | Fixed |
 | --- | --- | --- | --- |
 | %d | %d | %d | %d |
@@ -270,6 +269,15 @@ func Markdown(result *header2.Result) string {
 
   %v
 </details>
+
+<details>
+	<summary>Use this command to fix any missing license headers</summary>
+
+	`+"```bash\n"+
+		"docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix\n"+
+		"```"+
+		`
+</details>
 `,
 		Identification,
 		len(result.Success)+len(result.Failure)+len(result.Ignored),