Add debug logging to 5 key Go files for improved troubleshooting (#2681)

Author: github-actions[bot]

pkg/cli/interactive.go

@@ -10,8 +10,11 @@ import (
 	"github.com/charmbracelet/huh"
 	"github.com/githubnext/gh-aw/pkg/console"
 	"github.com/githubnext/gh-aw/pkg/constants"
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var interactiveLog = logger.New("cli:interactive")
+
 // InteractiveWorkflowBuilder collects user input to build an agentic workflow
 type InteractiveWorkflowBuilder struct {
 	WorkflowName  string
@@ -26,6 +29,8 @@ type InteractiveWorkflowBuilder struct {
 
 // CreateWorkflowInteractively prompts the user to build a workflow interactively
 func CreateWorkflowInteractively(workflowName string, verbose bool, force bool) error {
+	interactiveLog.Printf("Starting interactive workflow creation: workflowName=%s, force=%v", workflowName, force)
+
 	// Assert this function is not running in automated unit tests
 	if os.Getenv("GO_TEST_MODE") == "true" || os.Getenv("CI") != "" {
 		return fmt.Errorf("interactive workflow creation cannot be used in automated tests or CI environments")
@@ -247,6 +252,8 @@ func (b *InteractiveWorkflowBuilder) promptForIntent() error {
 
 // generateWorkflow creates the markdown workflow file based on user selections
 func (b *InteractiveWorkflowBuilder) generateWorkflow(force bool) error {
+	interactiveLog.Printf("Generating workflow file: name=%s, engine=%s, trigger=%s", b.WorkflowName, b.Engine, b.Trigger)
+
 	// Get current working directory for .github/workflows
 	workingDir, err := os.Getwd()
 	if err != nil {
@@ -275,6 +282,7 @@ func (b *InteractiveWorkflowBuilder) generateWorkflow(force bool) error {
 		return fmt.Errorf("failed to write workflow file '%s': %w", destFile, err)
 	}
 
+	interactiveLog.Printf("Workflow file created successfully: %s", destFile)
 	fmt.Fprintf(os.Stderr, "Created new workflow: %s\n", destFile)
 	return nil
 }

pkg/cli/logs.go

@@ -16,12 +16,15 @@ import (
 
 	"github.com/githubnext/gh-aw/pkg/console"
 	"github.com/githubnext/gh-aw/pkg/constants"
+	"github.com/githubnext/gh-aw/pkg/logger"
 	"github.com/githubnext/gh-aw/pkg/workflow"
 	"github.com/githubnext/gh-aw/pkg/workflow/pretty"
 	"github.com/sourcegraph/conc/pool"
 	"github.com/spf13/cobra"
 )
 
+var logsLog = logger.New("cli:logs")
+
 const (
 	// defaultAgentStdioLogPath is the default log file path for agent stdout/stderr
 	defaultAgentStdioLogPath = "/tmp/gh-aw/agent-stdio.log"
@@ -130,6 +133,7 @@ type RunSummary struct {
 
 // fetchJobStatuses gets job information for a workflow run and counts failed jobs
 func fetchJobStatuses(runID int64, verbose bool) (int, error) {
+	logsLog.Printf("Fetching job statuses: runID=%d", runID)
 	args := []string{"api", fmt.Sprintf("repos/{owner}/{repo}/actions/runs/%d/jobs", runID), "--jq", ".jobs[] | {name: .name, status: .status, conclusion: .conclusion}"}
 
 	if verbose {
@@ -165,12 +169,14 @@ func fetchJobStatuses(runID int64, verbose bool) (int, error) {
 		// Count jobs with failure conclusions as errors
 		if job.Conclusion == "failure" || job.Conclusion == "cancelled" || job.Conclusion == "timed_out" {
 			failedJobs++
+			logsLog.Printf("Found failed job: name=%s, conclusion=%s", job.Name, job.Conclusion)
 			if verbose {
 				fmt.Println(console.FormatVerboseMessage(fmt.Sprintf("Found failed job '%s' with conclusion '%s'", job.Name, job.Conclusion)))
 			}
 		}
 	}
 
+	logsLog.Printf("Job status check complete: failedJobs=%d", failedJobs)
 	return failedJobs, nil
 }
 
@@ -436,6 +442,7 @@ Examples:
 
 // DownloadWorkflowLogs downloads and analyzes workflow logs with metrics
 func DownloadWorkflowLogs(workflowName string, count int, startDate, endDate, outputDir, engine, branch string, beforeRunID, afterRunID int64, verbose bool, toolGraph bool, noStaged bool, parse bool, jsonOutput bool, timeout int) error {
+	logsLog.Printf("Starting workflow log download: workflow=%s, count=%d, startDate=%s, endDate=%s, outputDir=%s", workflowName, count, startDate, endDate, outputDir)
 	if verbose {
 		fmt.Fprintln(os.Stderr, console.FormatInfoMessage("Fetching workflow runs from GitHub Actions..."))
 	}
@@ -785,6 +792,7 @@ func downloadRunArtifactsConcurrent(runs []WorkflowRun, outputDir string, verbos
 	// Limit the number of runs to process if maxRuns is specified
 	actualRuns := runs
 	if maxRuns > 0 && len(runs) > maxRuns {
+		logsLog.Printf("Limiting concurrent downloads: maxRuns=%d, totalRuns=%d", maxRuns, len(runs))
 		actualRuns = runs[:maxRuns]
 	}
 

pkg/cli/secrets.go

@@ -8,9 +8,12 @@ import (
 	"regexp"
 	"strings"
 
+	"github.com/githubnext/gh-aw/pkg/logger"
 	"github.com/githubnext/gh-aw/pkg/parser"
 )
 
+var secretsLog = logger.New("cli:secrets")
+
 // Pre-compiled regexes for secret extraction (performance optimization)
 var (
 	secretPattern = regexp.MustCompile(`\$\{\{\s*secrets\.([A-Z_][A-Z0-9_]*)\s*(?:\|\|.*?)?\s*\}\}`)
@@ -27,6 +30,8 @@ type SecretInfo struct {
 
 // checkSecretExists checks if a secret exists in the repository using GitHub CLI
 func checkSecretExists(secretName string) (bool, error) {
+	secretsLog.Printf("Checking if secret exists: %s", secretName)
+
 	// Use gh CLI to list repository secrets
 	cmd := exec.Command("gh", "secret", "list", "--json", "name")
 	output, err := cmd.Output()
@@ -74,6 +79,7 @@ func extractSecretName(value string) string {
 
 // extractSecretsFromConfig extracts all required secrets from an MCP server config
 func extractSecretsFromConfig(config parser.MCPServerConfig) []SecretInfo {
+	secretsLog.Printf("Extracting secrets from MCP config: command=%s", config.Command)
 	var secrets []SecretInfo
 	seen := make(map[string]bool)
 
@@ -101,6 +107,7 @@ func extractSecretsFromConfig(config parser.MCPServerConfig) []SecretInfo {
 		}
 	}
 
+	secretsLog.Printf("Extracted %d secrets from config", len(secrets))
 	return secrets
 }
 

pkg/cli/workflows.go

@@ -10,8 +10,11 @@ import (
 	"strings"
 
 	"github.com/githubnext/gh-aw/pkg/console"
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var workflowsLog = logger.New("cli:workflows")
+
 // getPackagesDir returns the global packages directory path
 func getPackagesDir() (string, error) {
 	// Use global directory under user's home
@@ -57,6 +60,8 @@ type GitHubWorkflow struct {
 
 // fetchGitHubWorkflows fetches workflow information from GitHub
 func fetchGitHubWorkflows(repoOverride string, verbose bool) (map[string]*GitHubWorkflow, error) {
+	workflowsLog.Printf("Fetching GitHub workflows: repoOverride=%s", repoOverride)
+
 	// Start spinner for network operation (only if not in verbose mode)
 	spinner := console.NewSpinner("Fetching GitHub workflow status...")
 	if !verbose {
@@ -100,6 +105,7 @@ func fetchGitHubWorkflows(repoOverride string, verbose bool) (map[string]*GitHub
 		workflowMap[name] = &workflows[i]
 	}
 
+	workflowsLog.Printf("Fetched %d GitHub workflows", len(workflowMap))
 	return workflowMap, nil
 }
 
@@ -112,6 +118,8 @@ func extractWorkflowNameFromPath(path string) string {
 
 // getWorkflowStatus gets the status of a single workflow by name
 func getWorkflowStatus(workflowIdOrName string, repoOverride string, verbose bool) (*GitHubWorkflow, error) {
+	workflowsLog.Printf("Getting workflow status: workflow=%s", workflowIdOrName)
+
 	// Extract workflow name for lookup
 	filename := strings.TrimSuffix(filepath.Base(workflowIdOrName), ".md")
 

pkg/workflow/docker.go

@@ -8,8 +8,11 @@ import (
 	"strings"
 
 	"github.com/githubnext/gh-aw/pkg/console"
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var dockerLog = logger.New("workflow:docker")
+
 // collectDockerImages collects all Docker images used in MCP configurations
 func collectDockerImages(tools map[string]any) []string {
 	var images []string
@@ -60,6 +63,7 @@ func collectDockerImages(tools map[string]any) []string {
 
 	// Sort for stable output
 	sort.Strings(images)
+	dockerLog.Printf("Collected %d Docker images from tools", len(images))
 	return images
 }
 
@@ -80,9 +84,12 @@ func generateDownloadDockerImagesStep(yaml *strings.Builder, dockerImages []stri
 // validateDockerImage checks if a Docker image exists and is accessible
 // Returns nil if docker is not available (with a warning printed)
 func validateDockerImage(image string, verbose bool) error {
+	dockerLog.Printf("Validating Docker image: %s", image)
+
 	// Check if docker is available
 	_, err := exec.LookPath("docker")
 	if err != nil {
+		dockerLog.Print("Docker not available, skipping image validation")
 		// Docker not available - print warning and skip validation
 		if verbose {
 			fmt.Fprintln(os.Stderr, console.FormatWarningMessage(fmt.Sprintf("Docker not available - skipping validation for container image '%s'", image)))
@@ -96,10 +103,13 @@ func validateDockerImage(image string, verbose bool) error {
 
 	if err == nil {
 		// Image exists locally
+		dockerLog.Printf("Docker image found locally: %s", image)
 		_ = output // Suppress unused variable warning
 		return nil
 	}
 
+	dockerLog.Printf("Docker image not found locally, attempting to pull: %s", image)
+
 	// Image doesn't exist locally, try to pull it
 	pullCmd := exec.Command("docker", "pull", image)
 	pullOutput, pullErr := pullCmd.CombinedOutput()