Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 8, 2025

The compile command used [markdown-file]... while all other workflow commands (enable, disable, run, update) use [workflow-id]..., causing confusion since examples showed workflow IDs like ci-doctor rather than file paths.

Changes

  • Updated compile command placeholder from [markdown-file]... to [workflow-id]...
  • Clarified long description: "Compile one or more workflow IDs or Markdown files"
  • Changed "files" → "workflows" in help text for consistency

Before

Usage:
  gh compile [markdown-file]... [flags]

After

Usage:
  gh compile [workflow-id]... [flags]

Functionality unchanged—resolveWorkflowFile() still accepts both workflow IDs and file paths.

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/user
    • Triggering command: `/usr/bin/gh gh api user --jq .login it/ref/tags/v5 Fix inconsistent placeholder: use [workflow-id] instead of [markdown-file] in compile command

C-1` (http block)

  • Triggering command: `/usr/bin/gh gh api user --jq .login -java.git git /home/REDACTED/go/bin/node -3616025633.cjs mpile command

Ctest.js 64/bin/go node /hom�� tags/93cb6efe18208431cddfb8368fd83d5badbf9bfd ../../workflow/schemas/github-workflow.json /usr/local/sbin/sh /dev/null x_amd64/compile 64/bin/go sh` (http block)

  • Triggering command: /usr/bin/gh gh api user --jq .login ion-precompile.gtest-logs/run-5 ion-precompile.git 64713ed3c1e59087916cbeb0dff1b099ec2/log.json --show-toplevel x_amd64/vet 64/bin/go 1/x64/bin/npm -c prettier --write '../../**/*.json' '!../../workflow/js/**/*.json' --ignore-path OUTPUT git (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Inconsistent placeholder name: "workflow-id" vs "markdown-file" in compile command</issue_title>
<issue_description>## Issue Description

Command: gh aw compile
Type: Inconsistent parameter naming
Priority: Medium

Current Behavior

The compile command uses [markdown-file] as the parameter placeholder in its Use field:

From main.go line 168:

compileCmd := &cobra.Command{
    Use:   "compile [markdown-file]...",  // ← Uses "markdown-file"
    Short: "Compile Markdown to YAML workflows",
    // ...
}

However, all other commands that accept workflows use the [workflow-id] placeholder:

  • enable [workflow-id]...
  • disable [workflow-id]...
  • remove [workflow-id-pattern]
  • run (workflow-id)...
  • update [workflow-id]...
  • trial (workflow)... (slightly different but still workflow-focused)

Issue

This inconsistency is confusing because:

  1. The compile command's examples show it accepting workflow IDs (not full file paths):

    gh aw compile ci-doctor    # Not "ci-doctor.md"
    
  2. The help text says "If no files are specified, all Markdown files in .github/workflows will be compiled" - implying it accepts file specifications, but examples show workflow IDs

  3. Users might think they need to provide full paths like ./github/workflows/ci-doctor.md when they can just use ci-doctor

Suggested Fix

Change the parameter placeholder to match other commands:

Use:   "compile [workflow-id]...",

And update the Long description to clarify:

Long: `Compile one or more workflow IDs or Markdown files to YAML workflows.

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

This maintains the functionality (accepting both workflow IDs and file paths) while using consistent terminology with other commands.

AI generated by CLI Consistency Checker

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits December 8, 2025 16:20
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
…file] in compile command

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix inconsistent placeholder name in compile command Fix inconsistent parameter placeholder in compile command Dec 8, 2025
Copilot AI requested a review from mnkiefer December 8, 2025 16:45
@pelikhan pelikhan marked this pull request as ready for review December 8, 2025 16:58
@pelikhan pelikhan merged commit ffeced6 into main Dec 8, 2025
5 checks passed
@pelikhan pelikhan deleted the copilot/fix-inconsistent-placeholder-name branch December 8, 2025 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[cli-consistency] Inconsistent placeholder name: "workflow-id" vs "markdown-file" in compile command

3 participants