markdown support for json pr updates

deploymenttheory · Nov 1, 2024 · afe17b7 · afe17b7
1 parent 5d437dc
commit afe17b7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/.github/scripts/update_pr.py b/.github/scripts/update_pr.py
@@ -26,6 +26,9 @@ def open_drop_file() -> dict:
     with open(DROPFILE_PATH + "/outputs.json", "r", encoding="UTF-8") as f:
         return json.load(f)
 
+def wrap_json_markdown(json_string):
+    return f"```json\n{json_string}\n```"
+
 
 def get_pr():
     """
@@ -65,9 +68,9 @@ def update_pr_with_text(pr: github.PullRequest):
     json_data = open_drop_file()
 
     if TYPE == "plan":
-        comments.append(json.dumps(json_data["plan_output"], indent=2))
+        comments.append(wrap_json_markdown(json.dumps(json_data["plan_output"], indent=2)))
 
-    comments.append(json.dumps(json_data, indent=2))
+    comments.append(wrap_json_markdown(json.dumps(json_data, indent=2)))
 
     try:
         for c in comments:

diff --git a/.github/scripts/update_release.py b/.github/scripts/update_release.py
@@ -24,6 +24,10 @@ def open_drop_file() -> dict:
     with open(DROPFILE_PATH + "/outputs.json", "r", encoding="UTF-8") as f:
         return json.load(f)
 
+
+def wrap_json_markdown(json_string):
+    return f"```json\n{json_string}\n```"
+
 
 def get_update_release():
     """gets a tag"""