Function buildCommentBody

actions/setup/js/add_workflow_run_comment.cjs:351–381

* Build the comment body text for a workflow run link. * Sanitizes the content and appends all required markers. * @param {string} eventName - The event type * @param {string} runUrl - The URL of the workflow run * @param {string} [workflowNameOverride] - Optional dispatched workflow name overri

(eventName, runUrl, workflowNameOverride)

 * @returns {string} The assembled comment body
 */
function buildCommentBody(eventName, runUrl, workflowNameOverride) {
  // Whitespace-only overrides are treated as absent and fall back to env defaults.
  const normalizedWorkflowNameOverride = workflowNameOverride?.trim();
  const workflowName = normalizedWorkflowNameOverride || process.env.GH_AW_WORKFLOW_NAME || process.env.GITHUB_WORKFLOW || "Workflow";
  const eventTypeDescription = EVENT_TYPE_DESCRIPTIONS[eventName] ?? "event";

  // Sanitize before adding markers (defense in depth for custom message templates)
  let body = sanitizeContent(getRunStartedMessage({ workflowName, runUrl, eventType: eventTypeDescription }));

  // Add lock notice if lock-for-agent is enabled for issues or issue_comment
  if (process.env.GH_AW_LOCK_FOR_AGENT === "true" && (eventName === "issues" || eventName === "issue_comment")) {
    body += "\n\n🔒 This issue has been locked while the workflow is running to prevent concurrent modifications.";
  }

  // Add workflow-id marker for hide-older-comments feature
  const workflowId = process.env.GITHUB_WORKFLOW || "";
  if (workflowId) {
    body += `\n\n${generateWorkflowIdMarker(workflowId)}`;
  }

  // Add tracker-id marker for backwards compatibility
  const trackerId = process.env.GH_AW_TRACKER_ID || "";
  if (trackerId) {
    body += `\n\n<!-- gh-aw-tracker-id: ${trackerId} -->`;
  }

  // Identify this as a reaction comment (prevents it from being hidden by hide-older-comments)
  body += `\n\n<!-- gh-aw-comment-type: reaction -->`;

  return body;
}

/**
 * Post a GraphQL comment to a discussion, optionally as a threaded reply.