feat(reporting): improve codespan and github reporting messages

Signed-off-by: azjezz <azjezz@protonmail.com>
carthage-software · Dec 15, 2024 · 5cb7c13 · 5cb7c13
1 parent 0ca9a7f
commit 5cb7c13
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 3 deletions.
diff --git a/crates/reporting/src/internal/emitter/codespan.rs b/crates/reporting/src/internal/emitter/codespan.rs
@@ -249,11 +249,11 @@ impl From<Issue> for Diagnostic<SourceIdentifier> {
         }
 
         if let Some(help) = issue.help {
-            diagnostic.notes.push(format!("help: {}", help));
+            diagnostic.notes.push(format!("Help: {}", help));
         }
 
         if let Some(link) = issue.link {
-            diagnostic.notes.push(format!("see: {}", link));
+            diagnostic.notes.push(format!("See: {}", link));
         }
 
         diagnostic

diff --git a/crates/reporting/src/internal/emitter/github.rs b/crates/reporting/src/internal/emitter/github.rs
@@ -46,7 +46,31 @@ pub fn github_format(
             }
         };
 
-        writeln!(writer, "::{} {}::{}", level, properties, issue.message.as_str())?;
+        let mut message = issue.message.clone();
+
+        // we must use `%0A` instead of `\n`.
+        //
+        // see: https://github.com/actions/toolkit/issues/193
+        if !issue.notes.is_empty() {
+            message.push_str("%0A");
+
+            for note in issue.notes.iter() {
+                message.push_str("%0A");
+                message.push_str(note.as_str());
+            }
+        }
+
+        if let Some(help) = issue.help.as_ref() {
+            message.push_str("%0A%0AHelp: ");
+            message.push_str(help.as_str());
+        }
+
+        if let Some(link) = issue.link.as_ref() {
+            message.push_str("%0A%0AMore information: ");
+            message.push_str(link.as_str());
+        }
+
+        writeln!(writer, "::{} {}::{}", level, properties, message)?;
     }
 
     Ok(highest_level)