Skip to content

πŸ‘¨β€πŸ’» Add workflow description extraction feature#4008

Merged
dsyme merged 2 commits into
mainfrom
desc
Nov 15, 2025
Merged

πŸ‘¨β€πŸ’» Add workflow description extraction feature#4008
dsyme merged 2 commits into
mainfrom
desc

Conversation

@dsyme
Copy link
Copy Markdown
Collaborator

@dsyme dsyme commented Nov 15, 2025

Summary

Added a new feature to extract and display workflow descriptions from markdown files when adding or trialing workflows.

Changes

  • Created new functions ExtractWorkflowDescription() and ExtractWorkflowDescriptionFromFile() in pkg/cli/packages.go
  • Added comprehensive unit tests for description extraction in pkg/cli/add_description_test.go
  • Updated addWorkflowWithTracking() and RunWorkflowTrials() to display workflow descriptions
  • Handles various edge cases like missing descriptions, multi-line descriptions, and non-existent files

Benefits

  • Provides additional context when adding or trying out workflows
  • Improves user experience by showing workflow purpose at a glance
  • Adds robust description parsing with thorough test coverage

Testing

  • Added unit tests covering different description scenarios
  • Tested extraction from workflow markdown files with varying frontmatter

Copilot AI review requested due to automatic review settings November 15, 2025 01:38
@dsyme dsyme merged commit bffde33 into main Nov 15, 2025
10 checks passed
@dsyme dsyme deleted the desc branch November 15, 2025 01:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds workflow description extraction functionality to display workflow descriptions from markdown frontmatter when adding or trialing workflows. The implementation includes two new extraction functions, comprehensive unit tests, and integrations at two key points in the workflow lifecycle.

Key Changes

  • New extraction functions: Added ExtractWorkflowDescription() and ExtractWorkflowDescriptionFromFile() in packages.go to parse description fields from YAML frontmatter
  • Display integration: Updated addWorkflowWithTracking() and RunWorkflowTrials() to show extracted descriptions to users
  • Workflow metadata: Added description fields to 50+ workflow markdown files with clear, informative descriptions

Reviewed Changes

Copilot reviewed 153 out of 153 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pkg/cli/packages.go Implements description extraction from workflow content and files with graceful error handling
pkg/cli/add_description_test.go Comprehensive unit tests covering various description scenarios including edge cases
pkg/cli/add_command.go Integrates description display after workflow installation with formatted output
pkg/cli/trial_command.go Integrates description display during trial mode workflow installation
.github/workflows/*.md Adds descriptive metadata to 50+ workflow definitions for better discoverability
.github/workflows/*.lock.yml Compiled workflow outputs reflecting description additions and formatting updates

πŸ’‘ Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

github-actions Bot added a commit that referenced this pull request Nov 15, 2025
This commit updates the documentation based on features merged in the last 24 hours.

## Features Documented

### 1. Cross-repository --repo flag (PR #4007)
- Added --repo option to enable, disable, and logs commands
- Enables workflow management operations across different repositories
- Updated CLI reference with examples and option descriptions

### 2. Workflow description extraction (PR #4008)
- Documents that add and trial commands now display workflow descriptions
- Descriptions are extracted from frontmatter description field
- Provides better context about workflow purpose when adding or testing

### 3. Import cache for offline compilation (PR #3981)
- Remote imports are automatically cached in .github/aw/imports/
- Cache stores imports by commit SHA for efficient reuse
- Enables offline compilation once imports have been downloaded
- Updated CLI, imports reference, and packaging guides

### 4. "Did You Mean" schema validation suggestions (PR #3999)
- Compiler suggests correct field names for typos using fuzzy matching
- Based on Levenshtein distance algorithm
- Added tip callout and new error documentation section
- Includes examples of common typos detected

## Files Modified

- docs/src/content/docs/setup/cli.md
- docs/src/content/docs/reference/imports.md
- docs/src/content/docs/guides/packaging-imports.md
- docs/src/content/docs/troubleshooting/errors.md

## Related PRs

- #4007 - Add --repo options to more commands
- #4008 - Add workflow description extraction feature
- #3981 - Add import cache for offline workflow compilation
- #3999 - Implement 'Did You Mean' suggestions for schema validation

πŸ€– Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants