Skip to content

Improve compile command help text to clarify input/output formats #19988

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.

Sign up for GitHub

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

Merged
pelikhan merged 2 commits into from
Mar 7, 2026
+1 −1
Merged

Improve compile command help text to clarify input/output formats #19988

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8274aa6
Initial plan
Copilot Mar 7, 2026
6e9b826
fix: update compile command short description to clarify input/output…
Copilot Mar 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/gh-aw/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ Examples:

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)",
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

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)",

Copilot uses AI. Check for mistakes.
Long: `Compile one or more agentic workflows to YAML workflows.

If no workflows are specified, all Markdown files in .github/workflows will be compiled.
Expand Down