[plan] Add completion descriptions for workflow names using CompletionWithDesc

[github-actions]

Objective

Enhance shell completions to show workflow descriptions alongside workflow names when users press TAB, leveraging Cobra v1.9.0+ CompletionWithDesc functionality.

Context

Currently, shell completions only show workflow names. With completion descriptions, users will see:

my-workflow        Daily CI workflow for testing
deploy-prod        Production deployment workflow

This significantly improves discoverability and reduces need to check workflow files.

Implementation Approach

1. Locate completion function in pkg/cli/completions.go:

   • Find CompleteWorkflowNames() function

2. Create description extractor:

   func getWorkflowDescription(filepath string) string {
       // Read markdown file
       // Parse frontmatter
       // Extract 'description' or 'name' field
       // Return truncated string (max 60 chars)
   }

3. Update completion function to use tab-separated format:

   for _, file := range mdFiles {
       name := strings.TrimSuffix(filepath.Base(file), ".md")
       desc := getWorkflowDescription(file)
       completions = append(completions, fmt.Sprintf("%s\t%s", name, desc))
   }

4. Test in multiple shells:

   • Bash: gh aw run (TAB)
   • Zsh: gh aw compile (TAB)
   • Fish: gh aw enable (TAB)

Files to Modify

• Update: pkg/cli/completions.go

  • Modify CompleteWorkflowNames() to include descriptions
  • Add getWorkflowDescription() helper function

• Update: pkg/cli/completions_test.go (if exists, otherwise create)

  • Add tests for description extraction
  • Test truncation behavior

Acceptance Criteria

• Shell completions show workflow descriptions in bash/zsh/fish
• Descriptions are truncated to reasonable length (60 chars)
• Fallback to empty string if description not available
• No performance degradation (descriptions cached if needed)
• Test coverage for new functionality

References

• Cobra v1.9.0 CompletionWithDesc helper
• Format: "completion\tdescription" per shell completion standards
  Related to [plan] Enhance Cobra CLI implementation with completion descriptions and context support #8552

AI generated by Plan Command for discussion #8545

[github-actions]

🍪 Issue Monster has assigned this to Copilot!

I've identified this issue as a good candidate for automated resolution and assigned it to the Copilot agent.

The Copilot agent will analyze the issue and create a pull request with the fix.

Om nom nom! 🍪

AI generated by Issue Monster