Preserve durable provenance for superseded PR reviews

actions/setup/js/generate_footer.cjs

@@ -172,6 +172,63 @@ function generateWorkflowCallIdMarker(callerWorkflowId) {
   return `<!-- gh-aw-workflow-call-id: ${callerWorkflowId} -->`;
 }
 
+/**
+ * Generates a non-rendered Markdown reference definition carrying a workflow-call ID.
+ * Unlike HTML comments, GitHub preserves this form in pull request review bodies.
+ *
+ * @param {string} callerWorkflowId - Calling workflow identifier
+ * @returns {string} Markdown reference definition for review provenance
+ */
+function generateWorkflowCallIdReviewMarker(callerWorkflowId) {
+  return `[gh-aw-workflow-call-id]: # "${encodeURIComponent(callerWorkflowId)}"`;
+}
+
+/**
+ * Check whether any trimmed line of a body satisfies a marker predicate.
+ *
+ * @param {string|null|undefined} body - Body to scan
+ * @param {(line: string) => boolean} predicate - Predicate applied to each trimmed line
+ * @returns {boolean} Whether any line matches
+ */
+function someMarkerLine(body, predicate) {
+  if (!body) return false;
+  return body.split(/\r?\n/).some(line => predicate(line.trim()));
+}
+
+/**
+ * Check whether a body contains a line that exactly equals the given marker.
+ *
+ * @param {string|null|undefined} body - Body to scan
+ * @param {string} marker - Complete marker line
+ * @returns {boolean} Whether an exact marker line is present
+ */
+function matchesExactMarkerLine(body, marker) {
+  if (!marker) return false;
+  return someMarkerLine(body, line => line === marker);
+}
+
+/**
+ * Check whether a review body has an exact workflow-call ID marker line.
+ * Supports the legacy HTML comment and the durable Markdown reference marker.
+ *
+ * @param {string|null|undefined} body - Review body
+ * @param {string} callerWorkflowId - Calling workflow identifier
+ * @returns {boolean} Whether the review belongs to the calling workflow
+ */
+function matchesWorkflowCallId(body, callerWorkflowId) {
+  if (!body || !callerWorkflowId) return false;
+  if (matchesExactMarkerLine(body, generateWorkflowCallIdMarker(callerWorkflowId))) return true;
+  return someMarkerLine(body, trimmedLine => {
+    const durableMatch = trimmedLine.match(/^\[gh-aw-workflow-call-id\]: # "([^"]+)"$/);
+    if (!durableMatch) return false;
+    try {
+      return decodeURIComponent(durableMatch[1]) === callerWorkflowId;
+    } catch {
+      return false;
+    }
+  });
+}
+
 /**
  * Normalizes a user-supplied close-older-key to identifier style.
  * Converts to lowercase, replaces runs of non-alphanumeric/dash/underscore characters
@@ -294,6 +351,8 @@ module.exports = {
   generateXMLMarker,
   generateWorkflowIdMarker,
   generateWorkflowCallIdMarker,
+  generateWorkflowCallIdReviewMarker,
+  matchesWorkflowCallId,
   getWorkflowIdMarkerContent,
   matchesWorkflowId,
   isValidWorkflowId,

actions/setup/js/generate_footer.test.cjs

@@ -37,6 +37,8 @@ describe("generate_footer.cjs", () => {
   let generateXMLMarker;
   let generateWorkflowIdMarker;
   let generateWorkflowCallIdMarker;
+  let generateWorkflowCallIdReviewMarker;
+  let matchesWorkflowCallId;
   let getWorkflowIdMarkerContent;
   let normalizeCloseOlderKey;
 
@@ -58,6 +60,8 @@ describe("generate_footer.cjs", () => {
     generateXMLMarker = module.generateXMLMarker;
     generateWorkflowIdMarker = module.generateWorkflowIdMarker;
     generateWorkflowCallIdMarker = module.generateWorkflowCallIdMarker;
+    generateWorkflowCallIdReviewMarker = module.generateWorkflowCallIdReviewMarker;
+    matchesWorkflowCallId = module.matchesWorkflowCallId;
     getWorkflowIdMarkerContent = module.getWorkflowIdMarkerContent;
     normalizeCloseOlderKey = module.normalizeCloseOlderKey;
   });
@@ -246,6 +250,27 @@ describe("generate_footer.cjs", () => {
     });
   });
 
+  describe("generateWorkflowCallIdReviewMarker", () => {
+    it("should generate an encoded non-rendered marker", () => {
+      const result = generateWorkflowCallIdReviewMarker('owner/repo/Workflow "with" spaces');
+
+      expect(result).toBe('[gh-aw-workflow-call-id]: # "owner%2Frepo%2FWorkflow%20%22with%22%20spaces"');
+    });
+  });
+
+  describe("matchesWorkflowCallId", () => {
+    it("matches exact legacy and durable marker lines only", () => {
+      const callerWorkflowId = "owner/repo/Caller";
+
+      expect(matchesWorkflowCallId("Review\n<!-- gh-aw-workflow-call-id: owner/repo/Caller -->", callerWorkflowId)).toBe(true);
+      expect(matchesWorkflowCallId('[gh-aw-workflow-call-id]: # "owner%2Frepo%2FCaller"\nReview', callerWorkflowId)).toBe(true);
+      expect(matchesWorkflowCallId('[gh-aw-workflow-call-id]: # "owner%2frepo%2fCaller"', callerWorkflowId)).toBe(true);
+      expect(matchesWorkflowCallId('Quoted [gh-aw-workflow-call-id]: # "owner%2Frepo%2FCaller"', callerWorkflowId)).toBe(false);
+      expect(matchesWorkflowCallId('[gh-aw-workflow-call-id]: # "owner%2Frepo%2FCallerB"', callerWorkflowId)).toBe(false);
+      expect(matchesWorkflowCallId('[gh-aw-workflow-call-id]: # ""', "")).toBe(false);
+    });
+  });
+
   describe("getWorkflowIdMarkerContent", () => {
     it("should return marker content without XML wrapper", () => {
       const result = getWorkflowIdMarkerContent("test-workflow");

actions/setup/js/messages.test.cjs

@@ -36,6 +36,7 @@ describe("messages.cjs", () => {
     delete process.env.GH_AW_TRACKER_ID;
     delete process.env.GITHUB_RUN_ID;
     delete process.env.GH_AW_WORKFLOW_ID;
+    delete process.env.GH_AW_CALLER_WORKFLOW_ID;
     delete process.env.GH_AW_DEPRECATED_COST;
     delete process.env.GH_AW_AIC;
     delete process.env.GH_AW_AMBIENT_CONTEXT;
@@ -270,7 +271,7 @@ describe("messages.cjs", () => {
       expect(result).toBe("> Test (Test)");
     });
 
-    it("should append history link when historyUrl is provided", async () => {
+    it("should append provenance on its own line when historyUrl is provided", async () => {
       const { getFooterMessage } = await import("./messages.cjs");
 
       const result = getFooterMessage({
@@ -279,7 +280,20 @@ describe("messages.cjs", () => {
         historyUrl: "https://github.com/search?q=repo:test/repo+is:issue&type=issues",
       });
 
-      expect(result).toBe("> Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123) · [◷](https://github.com/search?q=repo:test/repo+is:issue&type=issues)");
+      expect(result).toBe("> Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123)\n> <sub>Provenance: [Test Workflow](https://github.com/search?q=repo:test/repo+is:issue&type=issues)</sub>");
+    });
+
+    it("should use the caller workflow ID as the provenance identifier", async () => {
+      process.env.GH_AW_CALLER_WORKFLOW_ID = "owner/repo/test-workflow";
+      const { getFooterMessage } = await import("./messages.cjs");
+
+      const result = getFooterMessage({
+        workflowName: "Test Workflow",
+        runUrl: "https://github.com/test/repo/actions/runs/123",
+        historyUrl: "https://github.com/search?q=repo:test/repo+is:issue&type=issues",
+      });
+
+      expect(result).toContain("> <sub>Provenance: [owner/repo/test-workflow](https://github.com/search?q=repo:test/repo+is:issue&type=issues)</sub>");
     });
 
     it("should include both triggering number and history link when both are provided", async () => {
@@ -292,7 +306,7 @@ describe("messages.cjs", () => {
         historyUrl: "https://github.com/search?q=repo:test/repo+is:issue&type=issues",
       });
 
-      expect(result).toBe("> Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123) for #42 · [◷](https://github.com/search?q=repo:test/repo+is:issue&type=issues)");
+      expect(result).toBe("> Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123) for #42\n> <sub>Provenance: [Test Workflow](https://github.com/search?q=repo:test/repo+is:issue&type=issues)</sub>");
     });
 
     it("should not append history link when historyUrl is not provided", async () => {
@@ -307,7 +321,7 @@ describe("messages.cjs", () => {
       expect(result).not.toContain("◷");
     });
 
-    it("should expose {history_link} placeholder in custom footer templates", async () => {
+    it("should replace the legacy {history_link} placeholder with standardized provenance", async () => {
       process.env.GH_AW_SAFE_OUTPUT_MESSAGES = JSON.stringify({
         footer: "> 🤖 *Generated by [{workflow_name}]({run_url})*{history_link}",
       });
@@ -321,7 +335,8 @@ describe("messages.cjs", () => {
         historyUrl,
       });
 
-      expect(result).toBe(`> 🤖 *Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123)* · [◷](${historyUrl})`);
+      expect(result).toBe(`> 🤖 *Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123)*\n> <sub>Provenance: [Test Workflow](${historyUrl})</sub>`);
+      expect(result).not.toContain("◷");
     });
 
     it("should render empty string for {history_link} when historyUrl is not provided", async () => {
@@ -410,7 +425,7 @@ describe("messages.cjs", () => {
         historyUrl,
       });
 
-      expect(result).toBe(`> Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123) · [◷](${historyUrl})`);
+      expect(result).toBe(`> Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123)\n> <sub>Provenance: [Test Workflow](${historyUrl})</sub>`);
     });
 
     it("should include AI Credits without AI Credits when GH_AW_AIC is set", async () => {
@@ -666,7 +681,7 @@ describe("messages.cjs", () => {
         slashCommand: "deploy",
       });
 
-      expect(result).toBe(`> Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123) · [◷](${historyUrl})\n> <sub>Comment <em>/deploy</em> to run again</sub>`);
+      expect(result).toBe(`> Generated by [Test Workflow](https://github.com/test/repo/actions/runs/123)\n> <sub>Provenance: [Test Workflow](${historyUrl})</sub>\n> <sub>Comment <em>/deploy</em> to run again</sub>`);
     });
 
     it("should include slash command hint in custom footer templates", async () => {
@@ -1214,7 +1229,7 @@ describe("messages.cjs", () => {
       expect(result).toBe("> Generated from [Test Workflow](https://github.com/test/repo/actions/runs/123)");
     });
 
-    it("should include history link without AI Credits in default footer", async () => {
+    it("should include provenance without AI Credits in default footer", async () => {
       process.env.GH_AW_DEPRECATED_COST = "5000";
       const historyUrl = "https://github.com/search?q=repo:test/repo+is:issue&type=issues";
 
@@ -1226,7 +1241,7 @@ describe("messages.cjs", () => {
         historyUrl,
       });
 
-      expect(result).toBe(`> Generated from [Test Workflow](https://github.com/test/repo/actions/runs/123) · [◷](${historyUrl})`);
+      expect(result).toBe(`> Generated from [Test Workflow](https://github.com/test/repo/actions/runs/123)\n> <sub>Provenance: [Test Workflow](${historyUrl})</sub>`);
     });
 
     it("should include AIC and ambient context in default footer when available", async () => {
@@ -1316,7 +1331,7 @@ describe("messages.cjs", () => {
       expect(result).toBe("> Generated from [Test Workflow](https://github.com/test/repo/actions/runs/123)");
     });
 
-    it("should include history link without AI Credits in default footer", async () => {
+    it("should include provenance without AI Credits in default footer", async () => {
       process.env.GH_AW_DEPRECATED_COST = "5000";
       const historyUrl = "https://github.com/search?q=repo:test/repo+is:issue&type=issues";
 
@@ -1328,7 +1343,7 @@ describe("messages.cjs", () => {
         historyUrl,
       });
 
-      expect(result).toBe(`> Generated from [Test Workflow](https://github.com/test/repo/actions/runs/123) · [◷](${historyUrl})`);
+      expect(result).toBe(`> Generated from [Test Workflow](https://github.com/test/repo/actions/runs/123)\n> <sub>Provenance: [Test Workflow](${historyUrl})</sub>`);
     });
 
     it("should include explicit context AIC in the default footer", async () => {

actions/setup/js/messages_footer.cjs

@@ -161,15 +161,27 @@ function getAICFromEnv() {
  * @property {string} [workflowSourceUrl] - GitHub URL for the workflow source
  * @property {number|string} [triggeringNumber] - Issue, PR, or discussion number that triggered this workflow
  * @property {"issue"|"PR"|"discussion"} [triggeringType] - Triggering item type used in the default footer
- * @property {string} [historyUrl] - GitHub search URL for items created by this workflow (for the history link)
- * @property {string} [historyLink] - Pre-formatted markdown history link (e.g. " · [◷](url)"), or "" if unavailable
+ * @property {string} [historyUrl] - GitHub search URL for items created by this workflow
+ * @property {string} [historyLink] - Deprecated history link placeholder, always ""
  * @property {number|string} [aiCredits] - Total AI Credits cost for the run (1 AIC == 0.01 USD)
  * @property {string} [emoji] - Optional emoji representing the workflow (from frontmatter)
  * @property {string} [slashCommand] - Slash command name (without leading slash) for the run-again hint, when applicable
  * @property {string} [slashCommandPlaceholder] - Custom hint text appended after the command name (replaces default "to run again")
  * @property {string} [labelCommand] - Label command name for the run-again hint, when applicable
  */
 
+/**
+ * Append a standardized provenance line when a history search is available.
+ * @param {string} footer - Rendered footer text
+ * @param {FooterContext} ctx - Context for footer generation
+ * @returns {string} Footer text with provenance
+ */
+function appendFooterProvenance(footer, ctx) {
+  if (!ctx.historyUrl) return footer;
+  const identifier = process.env.GH_AW_CALLER_WORKFLOW_ID || process.env.GH_AW_WORKFLOW_ID || ctx.workflowName;
+  return `${footer}\n> <sub>Provenance: [${identifier}](${ctx.historyUrl})</sub>`;
+}
+
 /**
  * Get the footer message, using custom template if configured.
  * @param {FooterContext} ctx - Context for footer generation
@@ -203,8 +215,8 @@ function getFooterMessage(ctx) {
   const detectionConclusion = process.env.GH_AW_DETECTION_CONCLUSION || undefined;
   const detectionReason = process.env.GH_AW_DETECTION_REASON || undefined;
 
-  // Pre-compute history_link as a ready-to-use markdown suffix (empty string when unavailable)
-  const historyLink = ctx.historyUrl ? ` · [◷](${ctx.historyUrl})` : "";
+  // Keep the legacy placeholder empty; provenance is rendered on its own line below.
+  const historyLink = "";
 
   // Pre-compute agentic_workflow_url as the direct link to the agentic workflow page
   const agenticWorkflowUrl = ctx.agenticWorkflowUrl || (ctx.runUrl ? `${ctx.runUrl}/agentic_workflow` : "");
@@ -265,7 +277,8 @@ function getFooterMessage(ctx) {
   // Use custom footer template if configured
   if (messages?.footer) {
     const renderedCustomFooter = renderTemplate(messages.footer, templateContext);
-    return renderedCustomFooter + getRunAgainHints(renderedCustomFooter);
+    const footer = appendFooterProvenance(renderedCustomFooter, ctx);
+    return footer + getRunAgainHints(footer);
   }
 
   // Default footer template - includes emoji prefix when available
@@ -285,12 +298,9 @@ function getFooterMessage(ctx) {
   if (metricSuffixes.length > 0) {
     defaultFooter += metricSuffixes.join("");
   }
-  // Append history link when available
-  if (ctx.historyUrl) {
-    defaultFooter += " · [◷]({history_url})";
-  }
   const renderedDefaultFooter = renderTemplate(defaultFooter, templateContext);
-  return renderedDefaultFooter + getRunAgainHints(renderedDefaultFooter);
+  const footer = appendFooterProvenance(renderedDefaultFooter, ctx);
+  return footer + getRunAgainHints(footer);
 }
 
 /**
@@ -422,8 +432,8 @@ function getFooterWorkflowRecompileCommentMessage(ctx) {
 function getFooterAgentFailureIssueMessage(ctx) {
   const messages = getMessages();
 
-  // Pre-compute history_link as a ready-to-use markdown suffix (empty string when unavailable)
-  const historyLink = ctx.historyUrl ? ` · [◷](${ctx.historyUrl})` : "";
+  // Keep the legacy placeholder empty; provenance is rendered on its own line below.
+  const historyLink = "";
 
   // Pre-compute agentic_workflow_url as the direct link to the agentic workflow page
   const agenticWorkflowUrl = ctx.agenticWorkflowUrl || (ctx.runUrl ? `${ctx.runUrl}/agentic_workflow` : "");
@@ -496,14 +506,10 @@ function getFooterAgentFailureIssueMessage(ctx) {
     if (ambientContext) {
       defaultFooter += ambientContextSuffix;
     }
-    // Append history link when available
-    if (ctx.historyUrl) {
-      defaultFooter += " · [◷]({history_url})";
-    }
     footer = renderTemplate(defaultFooter, templateContext);
   }
 
-  return footer;
+  return appendFooterProvenance(footer, ctx);
 }
 
 /**
@@ -514,8 +520,8 @@ function getFooterAgentFailureIssueMessage(ctx) {
 function getFooterAgentFailureCommentMessage(ctx) {
   const messages = getMessages();
 
-  // Pre-compute history_link as a ready-to-use markdown suffix (empty string when unavailable)
-  const historyLink = ctx.historyUrl ? ` · [◷](${ctx.historyUrl})` : "";
+  // Keep the legacy placeholder empty; provenance is rendered on its own line below.
+  const historyLink = "";
 
   // Pre-compute agentic_workflow_url as the direct link to the agentic workflow page
   const agenticWorkflowUrl = ctx.agenticWorkflowUrl || (ctx.runUrl ? `${ctx.runUrl}/agentic_workflow` : "");
@@ -588,14 +594,10 @@ function getFooterAgentFailureCommentMessage(ctx) {
     if (ambientContext) {
       defaultFooter += ambientContextSuffix;
     }
-    // Append history link when available
-    if (ctx.historyUrl) {
-      defaultFooter += " · [◷]({history_url})";
-    }
     footer = renderTemplate(defaultFooter, templateContext);
   }
 
-  return footer;
+  return appendFooterProvenance(footer, ctx);
 }
 
 /**