Fix diff-shades comment missing newlines (#3799)

Preserving newlines is done differently when writing to $GITHUB_OUTPUT
over the deprecated :set-output: command.

diff --git a/scripts/diff_shades_gha_helper.py b/scripts/diff_shades_gha_helper.py
index 994fbe0504509917113af7ef6e2bb1c651c36fa7..7a58fbe9b2809a616c97ad594e2c678edf8b29fc 100644 (file)
--- a/scripts/diff_shades_gha_helper.py
+++ b/scripts/diff_shades_gha_helper.py
@@ -21,6 +21,7 @@ import pprint
 import subprocess
 import sys
 import zipfile
 import subprocess
 import sys
 import zipfile

+from base64 import b64encode

 from io import BytesIO
 from pathlib import Path
 from typing import Any
 from io import BytesIO
 from pathlib import Path
 from typing import Any


@@ -53,12 +54,16 @@ def set_output(name: str, value: str) -> None:
     else:
         print(f"[INFO]: setting '{name}' to [{len(value)} chars]")
 
     else:
         print(f"[INFO]: setting '{name}' to [{len(value)} chars]")
 

-    # Originally the `set-output` workflow command was used here, now replaced
-    # by setting variables through the `GITHUB_OUTPUT` environment variable
-    # to stay up to date with GitHub's update.

     if "GITHUB_OUTPUT" in os.environ:
     if "GITHUB_OUTPUT" in os.environ:

+        if "\n" in value:
+            # https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings
+            delimiter = b64encode(os.urandom(16)).decode()
+            value = f"{delimiter}\n{value}\n{delimiter}"
+            command = f"{name}<<{value}"
+        else:
+            command = f"{name}={value}"

         with open(os.environ["GITHUB_OUTPUT"], "a") as f:
         with open(os.environ["GITHUB_OUTPUT"], "a") as f:

-            print(f"{name}={value}", file=f)
+            print(command, file=f)

 
 
 def http_get(url: str, *, is_json: bool = True, **kwargs: Any) -> Any:
 
 
 def http_get(url: str, *, is_json: bool = True, **kwargs: Any) -> Any:


@@ -224,9 +229,7 @@ def comment_details(run_id: str) -> None:
     # while it's still in progress seems impossible).
     body = body.replace("$workflow-run-url", data["html_url"])
     body = body.replace("$job-diff-url", diff_url)
     # while it's still in progress seems impossible).
     body = body.replace("$workflow-run-url", data["html_url"])
     body = body.replace("$job-diff-url", diff_url)

-    # https://github.community/t/set-output-truncates-multiline-strings/16852/3
-    escaped = body.replace("%", "%25").replace("\n", "%0A").replace("\r", "%0D")
-    set_output("comment-body", escaped)
+    set_output("comment-body", body)

 
 
 if __name__ == "__main__":
 
 
 if __name__ == "__main__":