Add customization field for footer and notification message formats (#4864)

Author: Copilot

docs/src/content/docs/reference/frontmatter-full.md

@@ -2176,6 +2176,34 @@ safe-outputs:
   jobs:
     {}
 
+  # Custom message templates for safe-output footer and notification messages. Use
+  # format strings with placeholders like {workflow_name}, {run_url},
+  # {triggering_number}.
+  # (optional)
+  messages:
+    # Custom footer message template for AI-generated content. Available placeholders:
+    # {workflow_name}, {run_url}, {triggering_number}, {workflow_source},
+    # {workflow_source_url}. Example: '> Generated by [{workflow_name}]({run_url})'
+    # (optional)
+    footer: "example-value"
+
+    # Custom installation instructions template appended to the footer. Available
+    # placeholders: {workflow_source}, {workflow_source_url}. Example: '> Install: `gh
+    # aw add {workflow_source}`'
+    # (optional)
+    footer-install: "example-value"
+
+    # Custom title template for staged mode preview. Available placeholders:
+    # {operation}. Example: '🎭 Preview: {operation}'
+    # (optional)
+    staged-title: "example-value"
+
+    # Custom description template for staged mode preview. Available placeholders:
+    # {operation}. Example: 'The following {operation} would occur if staged mode was
+    # disabled:'
+    # (optional)
+    staged-description: "example-value"
+
   # Runner specification for all safe-outputs jobs (activation, create-issue,
   # add-comment, etc.). Single runner label (e.g., 'ubuntu-slim', 'ubuntu-latest',
   # 'windows-latest', 'self-hosted'). Defaults to 'ubuntu-slim'. See

pkg/parser/schemas/main_workflow_schema.json

@@ -3618,6 +3618,57 @@
           },
           "additionalProperties": false
         },
+        "messages": {
+          "type": "object",
+          "description": "Custom message templates for safe-output footer and notification messages. Available placeholders: {workflow_name} (workflow name), {run_url} (GitHub Actions run URL), {triggering_number} (issue/PR/discussion number), {workflow_source} (owner/repo/path@ref), {workflow_source_url} (GitHub URL to source), {operation} (safe-output operation name for staged mode).",
+          "properties": {
+            "footer": {
+              "type": "string",
+              "description": "Custom footer message template for AI-generated content. Available placeholders: {workflow_name}, {run_url}, {triggering_number}, {workflow_source}, {workflow_source_url}. Example: '> Generated by [{workflow_name}]({run_url})'",
+              "examples": [
+                "> Generated by [{workflow_name}]({run_url})",
+                "> AI output from [{workflow_name}]({run_url}) for #{triggering_number}"
+              ]
+            },
+            "footer-install": {
+              "type": "string",
+              "description": "Custom installation instructions template appended to the footer. Available placeholders: {workflow_source}, {workflow_source_url}. Example: '> Install: `gh aw add {workflow_source}`'",
+              "examples": ["> Install: `gh aw add {workflow_source}`", "> [Add this workflow]({workflow_source_url})"]
+            },
+            "staged-title": {
+              "type": "string",
+              "description": "Custom title template for staged mode preview. Available placeholders: {operation}. Example: '🎭 Preview: {operation}'",
+              "examples": ["🎭 Preview: {operation}", "## Staged Mode: {operation}"]
+            },
+            "staged-description": {
+              "type": "string",
+              "description": "Custom description template for staged mode preview. Available placeholders: {operation}. Example: 'The following {operation} would occur if staged mode was disabled:'",
+              "examples": ["The following {operation} would occur if staged mode was disabled:"]
+            },
+            "run-started": {
+              "type": "string",
+              "description": "Custom message template for workflow activation comment. Available placeholders: {workflow_name}, {run_url}, {event_type}. Default: 'Agentic [{workflow_name}]({run_url}) triggered by this {event_type}.'",
+              "examples": [
+                "Agentic [{workflow_name}]({run_url}) triggered by this {event_type}.",
+                "[{workflow_name}]({run_url}) started processing this {event_type}."
+              ]
+            },
+            "run-success": {
+              "type": "string",
+              "description": "Custom message template for successful workflow completion. Available placeholders: {workflow_name}, {run_url}. Default: '✅ Agentic [{workflow_name}]({run_url}) completed successfully.'",
+              "examples": ["✅ Agentic [{workflow_name}]({run_url}) completed successfully.", "✅ [{workflow_name}]({run_url}) finished."]
+            },
+            "run-failure": {
+              "type": "string",
+              "description": "Custom message template for failed workflow. Available placeholders: {workflow_name}, {run_url}, {status}. Default: '❌ Agentic [{workflow_name}]({run_url}) {status} and wasn't able to produce a result.'",
+              "examples": [
+                "❌ Agentic [{workflow_name}]({run_url}) {status} and wasn't able to produce a result.",
+                "❌ [{workflow_name}]({run_url}) {status}."
+              ]
+            }
+          },
+          "additionalProperties": false
+        },
         "runs-on": {
           "type": "string",
           "description": "Runner specification for all safe-outputs jobs (activation, create-issue, add-comment, etc.). Single runner label (e.g., 'ubuntu-slim', 'ubuntu-latest', 'windows-latest', 'self-hosted'). Defaults to 'ubuntu-slim'. See https://github.blog/changelog/2025-10-28-1-vcpu-linux-runner-now-available-in-github-actions-in-public-preview/"

pkg/workflow/compiler.go

@@ -288,6 +288,18 @@ type SafeOutputsConfig struct {
 	GitHubToken                     string                                 `yaml:"github-token,omitempty"`   // GitHub token for safe output jobs
 	MaximumPatchSize                int                                    `yaml:"max-patch-size,omitempty"` // Maximum allowed patch size in KB (defaults to 1024)
 	RunsOn                          string                                 `yaml:"runs-on,omitempty"`        // Runner configuration for safe-outputs jobs
+	Messages                        *SafeOutputMessagesConfig              `yaml:"messages,omitempty"`       // Custom message templates for footer and notifications
+}
+
+// SafeOutputMessagesConfig holds custom message templates for safe-output footer and notification messages
+type SafeOutputMessagesConfig struct {
+	Footer            string `yaml:"footer,omitempty"`             // Custom footer message template
+	FooterInstall     string `yaml:"footer-install,omitempty"`     // Custom installation instructions template
+	StagedTitle       string `yaml:"staged-title,omitempty"`       // Custom staged mode title template
+	StagedDescription string `yaml:"staged-description,omitempty"` // Custom staged mode description template
+	RunStarted        string `yaml:"run-started,omitempty"`        // Custom workflow activation message template
+	RunSuccess        string `yaml:"run-success,omitempty"`        // Custom workflow success message template
+	RunFailure        string `yaml:"run-failure,omitempty"`        // Custom workflow failure message template
 }
 
 // SecretMaskingConfig holds configuration for secret redaction behavior

pkg/workflow/js.go

@@ -129,6 +129,9 @@ var generateFooterScript string
 //go:embed js/get_tracker_id.cjs
 var getTrackerIDScript string
 
+//go:embed js/messages.cjs
+var messagesScript string
+
 //go:embed js/get_repository_url.cjs
 var getRepositoryUrlScript string
 
@@ -178,6 +181,7 @@ func GetJavaScriptSources() map[string]string {
 		"update_activation_comment.cjs":   updateActivationCommentScript,
 		"generate_footer.cjs":             generateFooterScript,
 		"get_tracker_id.cjs":              getTrackerIDScript,
+		"messages.cjs":                    messagesScript,
 		"get_repository_url.cjs":          getRepositoryUrlScript,
 		"check_permissions_utils.cjs":     checkPermissionsUtilsScript,
 		"normalize_branch_name.cjs":       normalizeBranchNameScript,