[log] Add debug logging to workflow compiler and stringutil packages (#18564)

Author: github-actions[bot]

pkg/stringutil/pat_validation.go

@@ -3,8 +3,12 @@ package stringutil
 import (
 	"errors"
 	"strings"
+
+	"github.com/github/gh-aw/pkg/logger"
 )
 
+var patLog = logger.New("stringutil:pat_validation")
+
 // PATType represents the type of a GitHub Personal Access Token
 type PATType string
 
@@ -47,16 +51,19 @@ func (p PATType) IsValid() bool {
 // Returns:
 //   - PATType: The type of the token
 func ClassifyPAT(token string) PATType {
+	var patType PATType
 	switch {
 	case strings.HasPrefix(token, "github_pat_"):
-		return PATTypeFineGrained
+		patType = PATTypeFineGrained
 	case strings.HasPrefix(token, "ghp_"):
-		return PATTypeClassic
+		patType = PATTypeClassic
 	case strings.HasPrefix(token, "gho_"):
-		return PATTypeOAuth
+		patType = PATTypeOAuth
 	default:
-		return PATTypeUnknown
+		patType = PATTypeUnknown
 	}
+	patLog.Printf("Classified PAT type: %s", patType)
+	return patType
 }
 
 // IsFineGrainedPAT returns true if the token is a fine-grained personal access token
@@ -84,6 +91,7 @@ func IsOAuthToken(token string) bool {
 //   - error: An error with a descriptive message if the token is not valid, nil otherwise
 func ValidateCopilotPAT(token string) error {
 	patType := ClassifyPAT(token)
+	patLog.Printf("Validating Copilot PAT: type=%s", patType)
 
 	switch patType {
 	case PATTypeFineGrained:

pkg/workflow/compiler_error_formatter.go

@@ -5,14 +5,18 @@ import (
 	"fmt"
 
 	"github.com/github/gh-aw/pkg/console"
+	"github.com/github/gh-aw/pkg/logger"
 )
 
+var compilerErrorLog = logger.New("workflow:compiler_error_formatter")
+
 // formatCompilerError creates a formatted compiler error message with optional error wrapping
 // filePath: the file path to include in the error (typically markdownPath or lockFile)
 // errType: the error type ("error" or "warning")
 // message: the error message text
 // cause: optional underlying error to wrap (use nil for validation errors)
 func formatCompilerError(filePath string, errType string, message string, cause error) error {
+	compilerErrorLog.Printf("Formatting compiler error: file=%s, type=%s, message=%s", filePath, errType, message)
 	formattedErr := console.FormatError(console.CompilerError{
 		Position: console.ErrorPosition{
 			File:   filePath,
@@ -40,6 +44,7 @@ func formatCompilerError(filePath string, errType string, message string, cause
 // message: the error message text
 // cause: optional underlying error to wrap (use nil for validation errors)
 func formatCompilerErrorWithPosition(filePath string, line int, column int, errType string, message string, cause error) error {
+	compilerErrorLog.Printf("Formatting compiler error: file=%s, line=%d, column=%d, type=%s, message=%s", filePath, line, column, errType, message)
 	formattedErr := console.FormatError(console.CompilerError{
 		Position: console.ErrorPosition{
 			File:   filePath,

pkg/workflow/compiler_types.go

@@ -176,6 +176,8 @@ func NewCompiler(opts ...CompilerOption) *Compiler {
 	// Auto-detect action mode based on version in case version has been update
 	c.actionMode = DetectActionMode(c.version)
 
+	logTypes.Printf("Created compiler: version=%s, actionMode=%s, skipValidation=%t, strictMode=%t", c.version, c.actionMode, c.skipValidation, c.strictMode)
+
 	return c
 }
 

pkg/workflow/mcp_serena_config.go

@@ -2,18 +2,24 @@ package workflow
 
 import (
 	"strings"
+
+	"github.com/github/gh-aw/pkg/logger"
 )
 
+var serenaConfigLog = logger.New("workflow:mcp_serena_config")
+
 // isSerenaInLocalMode checks if Serena tool is configured with local mode
 func isSerenaInLocalMode(tools *ToolsConfig) bool {
 	if tools == nil || tools.Serena == nil {
 		return false
 	}
+	serenaConfigLog.Printf("Serena tool mode: %s", tools.Serena.Mode)
 	return tools.Serena.Mode == "local"
 }
 
 // generateSerenaLocalModeSteps generates steps to start Serena MCP server locally using uvx
 func generateSerenaLocalModeSteps(yaml *strings.Builder) {
+	serenaConfigLog.Print("Generating Serena local mode startup steps")
 	// Step 1: Choose port for Serena HTTP server
 	yaml.WriteString("      - name: Generate Serena MCP Server Config\n")
 	yaml.WriteString("        id: serena-config\n")

pkg/workflow/safe_output_config.go

@@ -9,6 +9,7 @@ import "strings"
 func (c *Compiler) parseBaseSafeOutputConfig(configMap map[string]any, config *BaseSafeOutputConfig, defaultMax int) {
 	// Set default max if provided
 	if defaultMax > 0 {
+		safeOutputsConfigLog.Printf("Setting default max: %d", defaultMax)
 		config.Max = defaultIntStr(defaultMax)
 	}
 
@@ -18,11 +19,13 @@ func (c *Compiler) parseBaseSafeOutputConfig(configMap map[string]any, config *B
 		case string:
 			// Accept GitHub Actions expression strings
 			if strings.HasPrefix(v, "${{") && strings.HasSuffix(v, "}}") {
+				safeOutputsConfigLog.Printf("Parsed max as GitHub Actions expression: %s", v)
 				config.Max = &v
 			}
 		default:
 			// Convert integer/float64/etc to string via parseIntValue
 			if maxInt, ok := parseIntValue(max); ok {
+				safeOutputsConfigLog.Printf("Parsed max as integer: %d", maxInt)
 				s := defaultIntStr(maxInt)
 				config.Max = s
 			}
@@ -32,6 +35,7 @@ func (c *Compiler) parseBaseSafeOutputConfig(configMap map[string]any, config *B
 	// Parse github-token
 	if githubToken, exists := configMap["github-token"]; exists {
 		if githubTokenStr, ok := githubToken.(string); ok {
+			safeOutputsConfigLog.Print("Parsed custom github-token from config")
 			config.GitHubToken = githubTokenStr
 		}
 	}