Conversation
Contributor
There was a problem hiding this comment.
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()andExtractWorkflowDescriptionFromFile()inpackages.goto parse description fields from YAML frontmatter - Display integration: Updated
addWorkflowWithTracking()andRunWorkflowTrials()to show extracted descriptions to users - Workflow metadata: Added
descriptionfields 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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added a new feature to extract and display workflow descriptions from markdown files when adding or trialing workflows.
Changes
ExtractWorkflowDescription()andExtractWorkflowDescriptionFromFile()inpkg/cli/packages.gopkg/cli/add_description_test.goaddWorkflowWithTracking()andRunWorkflowTrials()to display workflow descriptionsBenefits
Testing