feat/plan summary in collapsible (#1671)

* Make plan summary in its own collapsible comment

Author: motatoes

cli/pkg/digger/digger.go

@@ -319,10 +319,7 @@ func run(command string, job orchestrator.Job, policyChecker policy.Checker, org
 					if err != nil {
 						log.Printf("Failed to report plan. %v", err)
 					}
-					_, _, err = reporter.Report("\n"+planSummary, coreutils.AsComment("Terraform plan summary"))
-					if err != nil {
-						log.Printf("Failed to report summary of plan. %v", err)
-					}
+					reportPlanSummary(reporter, planSummary)
 				}
 			} else {
 				reportEmptyPlanOutput(reporter, projectLock.LockId())
@@ -517,6 +514,21 @@ func reportTerraformPlanOutput(reporter reporting.Reporter, projectId string, pl
 	}
 }
 
+func reportPlanSummary(reporter reporting.Reporter, summary string) {
+	var formatter func(string) string
+
+	if reporter.SupportsMarkdown() {
+		formatter = coreutils.AsCollapsibleComment("Plan summary", false)
+	} else {
+		formatter = coreutils.AsComment("Plan summary")
+	}
+
+	_, _, err := reporter.Report("\n"+summary, formatter)
+	if err != nil {
+		log.Printf("Failed to report plan summary. %v", err)
+	}
+}
+
 func reportEmptyPlanOutput(reporter reporting.Reporter, projectId string) {
 	identityFormatter := func(comment string) string {
 		return comment

libs/comment_utils/utils/comments.go

@@ -27,10 +27,16 @@ func GetTerraformOutputAsComment(summary string) func(string) string {
 }
 
 func AsCollapsibleComment(summary string, open bool) func(string) string {
+	var openTag string
+	if open {
+		openTag = "open=\"true\""
+	} else {
+		openTag = ""
+	}
 	return func(comment string) string {
-		return fmt.Sprintf(`<details><summary>` + summary + `</summary>
-  ` + comment + `
-</details>`)
+		return fmt.Sprintf(`<details %v><summary>`+summary+`</summary>
+  `+comment+`
+</details>`, openTag)
 	}
 }