-
Notifications
You must be signed in to change notification settings - Fork 28
Standardize CLI workflow identifier terminology to workflow-id
#4210
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
workflow-id
There was a problem hiding this 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 PR standardizes CLI terminology across all commands to consistently use workflow-id as the parameter name, replacing inconsistent terms like workflow-base-name and pattern. The changes improve usability by accepting both workflow basename (e.g., my-workflow) and full filename (e.g., my-workflow.md) formats, with normalization logic preventing double extensions.
Key Changes:
- Unified parameter terminology to
workflow-idacrossnew,remove,enable,disable,run,logs, andupdatecommands - Added dual format support accepting both basename and full filename formats
- Implemented normalization in
NewWorkflow()to strip.mdextension
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| cmd/gh-aw/main.go | Updated command parameter names and help text to use workflow-id terminology consistently; added dual format support examples |
| pkg/cli/commands.go | Added normalization logic in NewWorkflow() to strip .md extension from input |
| pkg/cli/commands_test.go | Added test case for .md extension normalization and updated test assertions |
| pkg/cli/logs.go | Updated help text to explain dual format support with examples |
| pkg/cli/update_command.go | Updated help text to explain dual format support with examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - aw.patch: Git patch of changes made during execution | ||
| - workflow-logs/: GitHub Actions workflow run logs (job logs organized in subdirectory) | ||
| The workflow-id is the basename of the markdown file without the .md extension. |
Copilot
AI
Nov 17, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The removed line 'For example, for 'weekly-research.md', use 'weekly-research' as the workflow ID.' provided valuable clarification that's now missing. Consider preserving this explanatory example alongside the new dual-format information to maintain clarity about the relationship between filenames and workflow IDs.
| The workflow-id is the basename of the markdown file without the .md extension. | |
| The workflow-id is the basename of the markdown file without the .md extension. | |
| For example, for 'weekly-research.md', use 'weekly-research' as the workflow ID. |
CLI commands used inconsistent terminology for workflow identifiers:
newused[workflow-base-name],removeused[pattern], while others used[workflow-id]. This created confusion about what argument format to provide.Changes
Standardized parameter naming: All commands now use
workflow-idterminologynew:[workflow-base-name]→[workflow-id]remove:[pattern]→[workflow-id-pattern]Added dual format support: Commands accept both basename and full filename
my-workflow(basename without extension)my-workflow.md(full filename)Normalized input handling:
NewWorkflow()strips.mdextension to prevent double extensionsEnhanced documentation: Help text now explains both accepted formats with examples
Example
All changes are backward compatible.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.