docs: clarify BuildSystemPromptWithPersona as public API

Document the exported function's purpose and usage pattern for external callers who want one-shot prompt assembly.
style: remove extraneous blank line
2026-05-10 03:25:21 -07:00 · 2026-05-10 03:25:17 -07:00 · 2026-05-10 03:25:13 -07:00
3 changed files with 6 additions and 5 deletions
@@ -71,6 +71,9 @@ inputs:
    required: false
    default: 'true'
  system-prompt-file:
+    description: 'Local file with additional system prompt instructions (e.g. security review focus)'
+    required: false
+    default: ''
  persona:
    description: 'Built-in persona name (security, architect, docs)'
    required: false
@@ -79,9 +82,6 @@ inputs:
    description: 'Path to persona JSON file with custom review focus'
    required: false
    default: ''
-    description: 'Local file with additional system prompt instructions (e.g. security review focus)'
-    required: false
-    default: ''

 runs:
  using: 'composite'
@@ -93,7 +93,6 @@ func main() {
 		os.Exit(1)
 	}

-
 	// Validate persona flags are mutually exclusive
 	if *personaName != "" && *personaFile != "" {
 		slog.Error("--persona and --persona-file are mutually exclusive")
@@ -92,7 +92,9 @@ func BuildPersonaSystemPrompt(p *Persona) string {
 }

 // BuildSystemPromptWithPersona constructs the full system prompt, using either
-// a persona or the default generic prompt.
+// a persona or the default generic prompt. This is a convenience wrapper that
+// combines BuildPersonaSystemPrompt (or BuildSystemBase) with patterns and conventions.
+// It is exported for use by callers who want one-shot prompt assembly.
 func BuildSystemPromptWithPersona(persona *Persona, conventions, patterns string) string {
 	var base string
 	if persona != nil {
Author	SHA1	Message	Date
Rodin	5682d8246a	docs: clarify BuildSystemPromptWithPersona as public API CI / test (pull_request) Successful in 14s Details CI / review (/openai/v1, gpt-5, gpt, openai, GPT_REVIEW_TOKEN) (pull_request) Successful in 1m19s Details CI / review (/openai/v1, gpt-5, security, openai, SECURITY_REVIEW.md, SECURITY_REVIEW_TOKEN) (pull_request) Successful in 1m28s Details Document the exported function's purpose and usage pattern for external callers who want one-shot prompt assembly.	2026-05-10 03:25:21 -07:00
Rodin	a82b2c483f	style: remove extraneous blank line	2026-05-10 03:25:17 -07:00
Rodin	b060f91e5b	fix(action): restore proper YAML structure for inputs - system-prompt-file now has description/required/default attributes - persona-file no longer has duplicate description keys - Fixes YAML parsing that was breaking existing users	2026-05-10 03:25:13 -07:00