Improve compile command help text to clarify input/output formats#19988
Merged
Improve compile command help text to clarify input/output formats#19988
Conversation
4 tasks
… formats (#issue) Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update compile command help text for clarity
Improve compile command help text to clarify input/output formats
Mar 7, 2026
This was referenced Mar 7, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates gh aw compile’s CLI help text to make the command’s input (.md) and output (.lock.yml) formats explicit, reducing confusion about what compilation produces.
Changes:
- Refined the
compilecommandShortdescription to mention.md→.lock.ymldirectly.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| var compileCmd = &cobra.Command{ | ||
| Use: "compile [workflow]...", | ||
| Short: "Compile agentic workflows from Markdown to GitHub Actions YAML", | ||
| Short: "Compile workflow markdown files (.md) into GitHub Actions workflows (.lock.yml)", |
There was a problem hiding this comment.
The Short help text uses "markdown" lowercase, while the rest of this command’s help and examples consistently refer to the format as "Markdown" (e.g., "Compile all Markdown files" a few lines below). For consistency in CLI help output, consider capitalizing it here as well.
Suggested change
| Short: "Compile workflow markdown files (.md) into GitHub Actions workflows (.lock.yml)", | |
| Short: "Compile workflow Markdown files (.md) into GitHub Actions workflows (.lock.yml)", |
This was referenced Mar 8, 2026
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.
Users—especially new ones—couldn't tell from
gh aw compile's short description what the command produces or why it's needed, leading to confusion when edited workflows didn't take effect.Change
Updated the
Shortdescription of thecompilecommand incmd/gh-aw/main.go:The new text makes the input (
.md) and output (.lock.yml) explicit directly in the help listing, without exceeding the 80-character limit.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/actions/github-script/git/ref/tags/v8/usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq .object.sha(http block)/usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq .object.sha json' --ignore-path ../../../.pr**/*.json(http block)/usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq .object.sha ACCEPT(http block)If you need me to access, download, or install something from one of these locations, you can either:
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.