Skip to content

fix: address 5 CLI help text consistency issues #28139

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 5 commits into from
Apr 23, 2026
Merged

fix: address 5 CLI help text consistency issues #28139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c92e5cf
Initial plan
Copilot Apr 23, 2026
b513d95
chore: outline plan for CLI consistency fixes
Copilot Apr 23, 2026
45bd983
fix: resolve CLI consistency issues in pr transfer, mcp-server, logs,…
Copilot Apr 23, 2026
f0f963b
fix: remove extra space before inline comment in trial_command.go
Copilot Apr 23, 2026
9a5a373
Merge remote-tracking branch 'origin/main' into copilot/fix-9919-1036…
Copilot Apr 23, 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
3 changes: 3 additions & 0 deletions docs/src/content/docs/agent-factory-status.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ These are experimental agentic workflows used by the GitHub Next team to learn,
| [Agent Performance Analyzer - Meta-Orchestrator](https://github.com/github/gh-aw/blob/main/.github/workflows/agent-performance-analyzer.md) | copilot | [![Agent Performance Analyzer - Meta-Orchestrator](https://github.com/github/gh-aw/actions/workflows/agent-performance-analyzer.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/agent-performance-analyzer.lock.yml) | - | - |
| [Agent Persona Explorer](https://github.com/github/gh-aw/blob/main/.github/workflows/agent-persona-explorer.md) | copilot | [![Agent Persona Explorer](https://github.com/github/gh-aw/actions/workflows/agent-persona-explorer.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/agent-persona-explorer.lock.yml) | - | - |
| [Agentic Observability Kit](https://github.com/github/gh-aw/blob/main/.github/workflows/agentic-observability-kit.md) | copilot | [![Agentic Observability Kit](https://github.com/github/gh-aw/actions/workflows/agentic-observability-kit.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/agentic-observability-kit.lock.yml) | - | - |
| [Agentic Optimization Kit](https://github.com/github/gh-aw/blob/main/.github/workflows/agentic-optimization-kit.md) | copilot | [![Agentic Optimization Kit](https://github.com/github/gh-aw/actions/workflows/agentic-optimization-kit.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/agentic-optimization-kit.lock.yml) | - | - |
| [Agentic Workflow Audit Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/audit-workflows.md) | claude | [![Agentic Workflow Audit Agent](https://github.com/github/gh-aw/actions/workflows/audit-workflows.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/audit-workflows.lock.yml) | - | - |
| [AI Moderator](https://github.com/github/gh-aw/blob/main/.github/workflows/ai-moderator.md) | codex | [![AI Moderator](https://github.com/github/gh-aw/actions/workflows/ai-moderator.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/ai-moderator.lock.yml) | - | - |
| [Approach Validator](https://github.com/github/gh-aw/blob/main/.github/workflows/approach-validator.md) | claude | [![Approach Validator](https://github.com/github/gh-aw/actions/workflows/approach-validator.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/approach-validator.lock.yml) | - | - |
Expand Down Expand Up @@ -85,10 +86,12 @@ These are experimental agentic workflows used by the GitHub Next team to learn,
| [Daily Secrets Analysis Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-secrets-analysis.md) | copilot | [![Daily Secrets Analysis Agent](https://github.com/github/gh-aw/actions/workflows/daily-secrets-analysis.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-secrets-analysis.lock.yml) | - | - |
| [Daily Security Red Team Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-security-red-team.md) | claude | [![Daily Security Red Team Agent](https://github.com/github/gh-aw/actions/workflows/daily-security-red-team.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-security-red-team.lock.yml) | - | - |
| [Daily Semgrep Scan](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-semgrep-scan.md) | copilot | [![Daily Semgrep Scan](https://github.com/github/gh-aw/actions/workflows/daily-semgrep-scan.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-semgrep-scan.lock.yml) | - | - |
| [Daily Skill Optimizer Improvements](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-skill-optimizer.md) | copilot | [![Daily Skill Optimizer Improvements](https://github.com/github/gh-aw/actions/workflows/daily-skill-optimizer.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-skill-optimizer.lock.yml) | - | - |
| [Daily Syntax Error Quality Check](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-syntax-error-quality.md) | copilot | [![Daily Syntax Error Quality Check](https://github.com/github/gh-aw/actions/workflows/daily-syntax-error-quality.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-syntax-error-quality.lock.yml) | - | - |
| [Daily Team Evolution Insights](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-team-evolution-insights.md) | claude | [![Daily Team Evolution Insights](https://github.com/github/gh-aw/actions/workflows/daily-team-evolution-insights.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-team-evolution-insights.lock.yml) | - | - |
| [Daily Team Status](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-team-status.md) | copilot | [![Daily Team Status](https://github.com/github/gh-aw/actions/workflows/daily-team-status.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-team-status.lock.yml) | `daily around 9:00 on weekdays` | - |
| [Daily Testify Uber Super Expert](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-testify-uber-super-expert.md) | copilot | [![Daily Testify Uber Super Expert](https://github.com/github/gh-aw/actions/workflows/daily-testify-uber-super-expert.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-testify-uber-super-expert.lock.yml) | - | - |
| [Daily Token Consumption Report (Sentry OTel)](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-token-consumption-report.md) | claude | [![Daily Token Consumption Report (Sentry OTel)](https://github.com/github/gh-aw/actions/workflows/daily-token-consumption-report.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-token-consumption-report.lock.yml) | - | - |
| [Daily Workflow Updater](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-workflow-updater.md) | copilot | [![Daily Workflow Updater](https://github.com/github/gh-aw/actions/workflows/daily-workflow-updater.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-workflow-updater.lock.yml) | - | - |
| [Dead Code Removal Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/dead-code-remover.md) | copilot | [![Dead Code Removal Agent](https://github.com/github/gh-aw/actions/workflows/dead-code-remover.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/dead-code-remover.lock.yml) | - | - |
| [DeepReport - Intelligence Gathering Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/deep-report.md) | claude | [![DeepReport - Intelligence Gathering Agent](https://github.com/github/gh-aw/actions/workflows/deep-report.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/deep-report.lock.yml) | `daily around 15:00 on weekdays` | - |
Expand Down
22 changes: 15 additions & 7 deletions docs/src/content/docs/reference/frontmatter-full.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,12 @@ on:

# Option 2: undefined

# Explicit additional custom workflow jobs that pre_activation and activation
# should depend on.
# (optional)
needs: []
# Array of strings

# Steps to inject into the pre-activation job. These steps run after all built-in
# checks (membership, stop-time, skip-if, etc.) and their results are exposed as
# pre-activation outputs. Use 'id' on steps to reference their results via
Expand Down Expand Up @@ -983,11 +989,6 @@ on:
# (optional)
statuses: "read"

# Explicit additional custom workflow jobs that pre_activation and activation
# should depend on.
# (optional)
needs: ["secrets_fetcher"]

# When set to false, disables the frontmatter hash check step in the activation
# job. Default is true (check is enabled). Useful when the workflow source files
# are managed outside the default GitHub repo context (e.g. cross-repo org
Expand Down Expand Up @@ -1469,8 +1470,8 @@ pre-steps:
pre-steps: []
# Array items: undefined

# Custom workflow steps to run before MCP gateway startup in the agent job,
# so prerequisite MCP installation/configuration can happen first.
# Custom workflow steps to run immediately before AI execution, after all
# initialization and setup steps in the agent job.
# (optional)
Comment on lines +1473 to 1475
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

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

The updated pre-agent-steps description claims these steps run immediately before AI execution after all initialization/setup, but the compiler currently injects pre-agent-steps before MCP setup/gateway startup (see pkg/workflow/compiler_yaml_main_job.go where generatePreAgentSteps runs before generateMCPSetup). Please update this documentation to match the actual execution order, or adjust the compiler if the behavior has changed.

Copilot uses AI. Check for mistakes.
# This field supports multiple formats (oneOf):

Expand Down Expand Up @@ -3488,6 +3489,13 @@ safe-outputs:
assignees: []
# Array items: string

# Optional labels to apply to fallback issues created when pull request creation
# cannot proceed. When omitted, fallback issues reuse pull request labels. A
# managed label is always added for triage.
# (optional)
fallback-labels: []
# Array of strings

# Whether to create pull request as draft (defaults to true). Accepts a boolean or
# a GitHub Actions expression.
# (optional)
Expand Down
3 changes: 3 additions & 0 deletions pkg/cli/logs_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ Examples:
` + string(constants.CLIExtensionPrefix) + ` logs --ref main # Filter logs by branch or tag
` + string(constants.CLIExtensionPrefix) + ` logs --ref feature-xyz # Filter logs by feature branch
` + string(constants.CLIExtensionPrefix) + ` logs --filtered-integrity # Filter logs with DIFC (data integrity flow control) integrity-filtered items in the gateway logs
` + string(constants.CLIExtensionPrefix) + ` logs --no-staged # Exclude staged workflow runs from results

# Run ID range filtering
` + string(constants.CLIExtensionPrefix) + ` logs --after-run-id 1000 # Filter runs after run ID 1000
Expand All @@ -91,6 +92,8 @@ Examples:
` + string(constants.CLIExtensionPrefix) + ` logs --format markdown # Generate cross-run security audit report in Markdown
` + string(constants.CLIExtensionPrefix) + ` logs --format pretty # Generate cross-run security audit report in console format
` + string(constants.CLIExtensionPrefix) + ` logs weekly-research --format markdown --last 10 # Cross-run report for last 10 runs
` + string(constants.CLIExtensionPrefix) + ` logs --train # Train log pattern weights from last 10 runs
` + string(constants.CLIExtensionPrefix) + ` logs my-workflow --train -c 50 # Train log pattern weights from up to 50 runs of a specific workflow

# Cross-repository
` + string(constants.CLIExtensionPrefix) + ` logs weekly-research --repo owner/repo # Download logs from specific repository`,
Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/mcp_server_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Examples:
gh aw mcp-server --port 8080 # Run HTTP server on port 8080 (for web-based clients)
gh aw mcp-server --cmd ./gh-aw # Use custom gh-aw binary path
GITHUB_ACTOR=octocat gh aw mcp-server # Set actor via environment variable for access control
DEBUG=mcp:* GITHUB_ACTOR=octocat gh aw mcp-server # Run with verbose logging and actor`,
DEBUG=mcp:* GITHUB_ACTOR=octocat gh aw mcp-server # Run with verbose debug logging and actor set via environment variable`,
RunE: func(cmd *cobra.Command, args []string) error {
return runMCPServer(port, cmdPath, validateActor)
},
Expand Down
4 changes: 2 additions & 2 deletions pkg/cli/pr_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ func NewPRCommand() *cobra.Command {
Long: `Pull request management utilities for transferring PRs between repositories.

This command provides tools for transferring pull requests from one repository
to another, including the code changes, title, and description. Useful for
to another, including the code changes, title, and body. Useful for
migrating work from trial repositories to production repositories.

Available subcommands:
Expand Down Expand Up @@ -84,7 +84,7 @@ The command will:
1. Fetch the PR details (title, body, changes)
2. Apply changes as a single squashed commit
3. Create a new PR in the target repository
4. Copy the original title and description`,
4. Copy the original title and body`,
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
prURL := args[0]
Expand Down
1 change: 1 addition & 0 deletions pkg/cli/trial_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Auto-merge examples:
Advanced examples:
` + string(constants.CLIExtensionPrefix) + ` trial githubnext/agentics/my-workflow --host-repo . # Use current repo as host
` + string(constants.CLIExtensionPrefix) + ` trial ./local-workflow.md --clone-repo upstream/repo --repeat 2
` + string(constants.CLIExtensionPrefix) + ` trial githubnext/agentics/my-workflow --trigger-context https://github.com/owner/repo/issues/123 # Provide issue context for issue-triggered workflows

Repository modes:
- Default mode (no flags): Creates a temporary trial repository and simulates execution as if running against the current repository (github.repository context points to current repo)
Expand Down