Update comment-memory rendering to use six-backtick code regions (#28115)

Author: Copilot

actions/setup/js/comment_memory.cjs

@@ -14,7 +14,7 @@ const { buildWorkflowRunUrl } = require("./workflow_metadata_helpers.cjs");
 const { getTrackerID } = require("./get_tracker_id.cjs");
 const { generateHistoryUrl } = require("./generate_history_link.cjs");
 const { enforceCommentLimits } = require("./comment_limit_helpers.cjs");
-const { COMMENT_MEMORY_TAG, COMMENT_MEMORY_MAX_SCAN_PAGES } = require("./comment_memory_helpers.cjs");
+const { COMMENT_MEMORY_TAG, COMMENT_MEMORY_MAX_SCAN_PAGES, COMMENT_MEMORY_CODE_FENCE } = require("./comment_memory_helpers.cjs");
 // Require provenance marker to avoid accidentally updating user-authored comments
 // that happen to contain a matching comment-memory tag.
 const MANAGED_COMMENT_PROVENANCE_MARKER = "<!-- gh-aw-agentic-workflow:";
@@ -45,7 +45,7 @@ function buildManagedMemoryBody(rawBody, memoryID, options) {
   const openingTag = `<${COMMENT_MEMORY_TAG} id="${memoryID}">`;
   const closingTag = `</${COMMENT_MEMORY_TAG}>`;
   core.info(`comment_memory: building managed body for memory_id='${memoryID}'`);
-  let body = `${MANAGED_COMMENT_HEADER}\n\n${openingTag}\n${sanitizeContent(rawBody)}\n${closingTag}`;
+  let body = `${MANAGED_COMMENT_HEADER}\n\n${openingTag}\n${COMMENT_MEMORY_CODE_FENCE}\n${sanitizeContent(rawBody)}\n${COMMENT_MEMORY_CODE_FENCE}\n${closingTag}`;
 
   const tracker = getTrackerID("markdown");
   if (tracker) {

actions/setup/js/comment_memory.test.cjs

@@ -45,6 +45,7 @@ describe("comment_memory", () => {
     });
     expect(body).toContain("### Comment Memory");
     expect(body).toContain('<gh-aw-comment-memory id="default">');
+    expect(body).toContain("``````");
     expect(body).toContain("Hello world");
     expect(body).toContain("</gh-aw-comment-memory>");
   });
@@ -63,6 +64,7 @@ describe("comment_memory", () => {
     });
     expect(body).toContain("### Comment Memory");
     expect(body).toContain('<gh-aw-comment-memory id="session">');
+    expect(body).toContain("``````");
     expect(body).toContain("Persist me");
     expect(body).toContain("> [!NOTE]");
     expect(body).toContain("> <summary>What this comment does</summary>");

actions/setup/js/comment_memory_helpers.cjs

@@ -11,6 +11,23 @@ const COMMENT_MEMORY_MAX_SCAN_PAGES = 50;
 const COMMENT_MEMORY_MAX_SCAN_EMPTY_PAGES = 5;
 const COMMENT_MEMORY_PROMPT_START_MARKER = "<!-- gh-aw-comment-memory-prompt:start -->";
 const COMMENT_MEMORY_PROMPT_END_MARKER = "<!-- gh-aw-comment-memory-prompt:end -->";
+const COMMENT_MEMORY_CODE_FENCE = "``````";
+const ESCAPED_COMMENT_MEMORY_CODE_FENCE = COMMENT_MEMORY_CODE_FENCE.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+
+function stripCommentMemoryCodeFence(content) {
+  const trimmed = typeof content === "string" ? content.trim() : "";
+  if (trimmed.length === 0) {
+    return "";
+  }
+  if (!trimmed.startsWith(COMMENT_MEMORY_CODE_FENCE)) {
+    return trimmed;
+  }
+  const match = trimmed.match(new RegExp(`^${ESCAPED_COMMENT_MEMORY_CODE_FENCE}[^\\n]*\\n([\\s\\S]*)\\n${ESCAPED_COMMENT_MEMORY_CODE_FENCE}$`));
+  if (!match) {
+    return trimmed;
+  }
+  return match[1].trim();
+}
 
 function isSafeMemoryId(memoryId) {
   if (typeof memoryId !== "string" || memoryId.length === 0 || memoryId.length > MAX_MEMORY_ID_LENGTH) {
@@ -57,7 +74,7 @@ function extractCommentMemoryEntries(commentBody, warn = () => {}) {
     if (isSafeMemoryId(memoryId)) {
       entries.push({
         memoryId,
-        content: (commentBody.slice(contentStart, closeStart) || "").trim(),
+        content: stripCommentMemoryCodeFence(commentBody.slice(contentStart, closeStart)),
       });
     } else {
       warn(`skipping unsafe memory_id '${memoryId}'`);
@@ -99,7 +116,9 @@ module.exports = {
   COMMENT_MEMORY_MAX_SCAN_EMPTY_PAGES,
   COMMENT_MEMORY_PROMPT_START_MARKER,
   COMMENT_MEMORY_PROMPT_END_MARKER,
+  COMMENT_MEMORY_CODE_FENCE,
   isSafeMemoryId,
+  stripCommentMemoryCodeFence,
   extractCommentMemoryEntries,
   listCommentMemoryFiles,
   resolveCommentMemoryConfig,

actions/setup/js/comment_memory_helpers.test.cjs

@@ -1,12 +1,47 @@
 import { describe, it, expect, vi } from "vitest";
-import { extractCommentMemoryEntries, isSafeMemoryId } from "./comment_memory_helpers.cjs";
+import { extractCommentMemoryEntries, isSafeMemoryId, stripCommentMemoryCodeFence } from "./comment_memory_helpers.cjs";
 
 describe("comment_memory_helpers", () => {
   it("extracts managed memory entries", () => {
+    const entries = extractCommentMemoryEntries('<gh-aw-comment-memory id="default">\n``````\nhello\n``````\n</gh-aw-comment-memory>');
+    expect(entries).toEqual([{ memoryId: "default", content: "hello" }]);
+  });
+
+  it("supports legacy memory entries without code fence markers", () => {
     const entries = extractCommentMemoryEntries('<gh-aw-comment-memory id="default">\nhello\n</gh-aw-comment-memory>');
     expect(entries).toEqual([{ memoryId: "default", content: "hello" }]);
   });
 
+  it("keeps fenced text unchanged when trailing content exists after closing fence", () => {
+    const content = "``````\nhello\n``````\ntrailing";
+    expect(stripCommentMemoryCodeFence(content)).toBe(content);
+  });
+
+  it("keeps fenced text unchanged when closing fence is missing", () => {
+    const content = "``````\nhello";
+    expect(stripCommentMemoryCodeFence(content)).toBe(content);
+  });
+
+  it("keeps malformed fenced text unchanged", () => {
+    const content = "``````hello\n``````";
+    expect(stripCommentMemoryCodeFence(content)).toBe(content);
+  });
+
+  it("strips valid fenced text with extra newlines before content", () => {
+    const content = "``````\n\nhello\n``````";
+    expect(stripCommentMemoryCodeFence(content)).toBe("hello");
+  });
+
+  it("strips valid fenced text when content contains six-backtick lines", () => {
+    const content = "``````\nline 1\n``````\nline 2\n``````";
+    expect(stripCommentMemoryCodeFence(content)).toBe("line 1\n``````\nline 2");
+  });
+
+  it("keeps fenced text unchanged when closing fence has no leading newline", () => {
+    const content = "``````\nhello``````";
+    expect(stripCommentMemoryCodeFence(content)).toBe(content);
+  });
+
   it("rejects unsafe memory IDs", () => {
     const warning = vi.fn();
     const entries = extractCommentMemoryEntries('<gh-aw-comment-memory id="../bad">\nhello\n</gh-aw-comment-memory>', warning);

actions/setup/js/setup_comment_memory_files.test.cjs

@@ -35,7 +35,7 @@ describe("setup_comment_memory_files", () => {
 
   it("extracts memory entries from managed comment body", async () => {
     const module = await import("./setup_comment_memory_files.cjs");
-    const entries = module.extractCommentMemoryEntries('<gh-aw-comment-memory id="default">\nhello\n</gh-aw-comment-memory>');
+    const entries = module.extractCommentMemoryEntries('<gh-aw-comment-memory id="default">\n``````\nhello\n``````\n</gh-aw-comment-memory>');
     expect(entries).toEqual([{ memoryId: "default", content: "hello" }]);
   });
 
@@ -47,7 +47,7 @@ describe("setup_comment_memory_files", () => {
           listComments: vi.fn().mockResolvedValue({
             data: [
               {
-                body: '<gh-aw-comment-memory id="default">\nSaved memory\n</gh-aw-comment-memory>\nfooter',
+                body: '<gh-aw-comment-memory id="default">\n``````\nSaved memory\n``````\n</gh-aw-comment-memory>\nfooter',
               },
             ],
           }),
@@ -76,7 +76,7 @@ describe("setup_comment_memory_files", () => {
         });
       }
       if (page === 6) {
-        return Promise.resolve({ data: [{ body: '<gh-aw-comment-memory id="default">\nLate memory\n</gh-aw-comment-memory>' }] });
+        return Promise.resolve({ data: [{ body: '<gh-aw-comment-memory id="default">\n``````\nLate memory\n``````\n</gh-aw-comment-memory>' }] });
       }
       return Promise.resolve({ data: [] });
     });
@@ -156,7 +156,7 @@ describe("setup_comment_memory_files", () => {
       })
     );
     const listComments = vi.fn().mockResolvedValue({
-      data: [{ body: '<gh-aw-comment-memory id="default">\nCross repo memory\n</gh-aw-comment-memory>' }],
+      data: [{ body: '<gh-aw-comment-memory id="default">\n``````\nCross repo memory\n``````\n</gh-aw-comment-memory>' }],
     });
     global.github = {
       rest: {
@@ -192,7 +192,7 @@ describe("setup_comment_memory_files", () => {
       })
     );
     const listComments = vi.fn().mockResolvedValue({
-      data: [{ body: '<gh-aw-comment-memory id="default">\nSame repo memory\n</gh-aw-comment-memory>' }],
+      data: [{ body: '<gh-aw-comment-memory id="default">\n``````\nSame repo memory\n``````\n</gh-aw-comment-memory>' }],
     });
     global.github = {
       rest: {