-
Notifications
You must be signed in to change notification settings - Fork 276
docs: update init/upgrade/fix help text to remove stale .github/aw/ prompt file references #18218
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -117,7 +117,7 @@ Commands are organized by workflow lifecycle: creating, building, testing, monit | |||||
|
|
||||||
| #### `init` | ||||||
|
|
||||||
| Initialize repository for agentic workflows. Configures `.gitattributes`, Copilot instructions, prompt files, and logs `.gitignore`. Enables MCP server integration by default (use `--no-mcp` to skip). Without arguments, enters interactive mode for engine selection and secret configuration. | ||||||
| Initialize repository for agentic workflows. Configures `.gitattributes`, creates the dispatcher agent file (`.github/agents/agentic-workflows.agent.md`), and logs `.gitignore`. Enables MCP server integration by default (use `--no-mcp` to skip). Without arguments, enters interactive mode for engine selection and secret configuration. | ||||||
|
||||||
| Initialize repository for agentic workflows. Configures `.gitattributes`, creates the dispatcher agent file (`.github/agents/agentic-workflows.agent.md`), and logs `.gitignore`. Enables MCP server integration by default (use `--no-mcp` to skip). Without arguments, enters interactive mode for engine selection and secret configuration. | |
| Initialize repository for agentic workflows. Configures `.gitattributes` and creates the dispatcher agent file (`.github/agents/agentic-workflows.agent.md`). Enables MCP server integration by default (use `--no-mcp` to skip). Without arguments, enters interactive mode for engine selection and secret configuration. |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -43,9 +43,7 @@ gh aw init | |||||
| **What this does**: | ||||||
|
|
||||||
| - Configures `.gitattributes` to mark `.lock.yml` files as generated | ||||||
| - Creates `.github/aw/github-agentic-workflows.md` with comprehensive documentation | ||||||
| - Creates `.github/agents/agentic-workflows.agent.md` as an AI assistant for workflows | ||||||
| - Creates workflow management prompts in `.github/aw/` directory | ||||||
| - Creates `.github/agents/agentic-workflows.agent.md` as the dispatcher agent for AI workflows | ||||||
| - Configures VSCode settings in `.vscode/settings.json` | ||||||
| - Creates GH-AW MCP server configuration in `.vscode/mcp.json` | ||||||
| - Creates `.github/workflows/copilot-setup-steps.yml` with setup instructions | ||||||
|
|
@@ -63,7 +61,6 @@ git status | |||||
| You should see new/modified files including: | ||||||
|
|
||||||
| - `.gitattributes` | ||||||
| - `.github/aw/github-agentic-workflows.md` | ||||||
| - `.github/agents/agentic-workflows.agent.md` | ||||||
| - `.vscode/settings.json` | ||||||
| - `.vscode/mcp.json` | ||||||
|
|
@@ -105,7 +102,7 @@ After successful initialization, the user can: | |||||
| - **Add workflows from repos**: `gh aw add githubnext/agentics` | ||||||
| - **Create new workflows**: `gh aw new <workflow-name>` os using the agent | ||||||
|
||||||
| - **Create new workflows**: `gh aw new <workflow-name>` os using the agent | |
| - **Create new workflows**: `gh aw new <workflow-name>` or using the agent |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -182,7 +182,7 @@ func deleteOldTemplateFiles(verbose bool) error { | |||||
| return nil | ||||||
| } | ||||||
|
|
||||||
| // deleteOldAgentFiles deletes old .agent.md files that have been moved to .github/aw/ | ||||||
| // deleteOldAgentFiles deletes old workflow-specific .agent.md files from .github/agents/ | ||||||
|
||||||
| // deleteOldAgentFiles deletes old workflow-specific .agent.md files from .github/agents/ | |
| // deleteOldAgentFiles deletes old workflow-specific agent/template files from .github/agents/ and .github/aw/ |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,7 +45,7 @@ Available codemods: | |
| • safe-inputs-mode-removal: Removes deprecated 'safe-inputs.mode' field | ||
| • schedule-at-to-around-migration: Converts 'daily at TIME' to 'daily around TIME' | ||
| • delete-schema-file: Deletes deprecated .github/aw/schemas/agentic-workflow.json | ||
| • delete-old-agents: Deletes old .agent.md files moved to .github/aw/ | ||
| • delete-old-agents: Deletes old workflow-specific .agent.md files from .github/agents/ | ||
| • delete-old-templates: Removes old template files from pkg/cli/templates/ | ||
|
Comment on lines
47
to
49
|
||
|
|
||
| If no workflows are specified, all Markdown files in .github/workflows will be processed. | ||
|
|
@@ -55,10 +55,9 @@ The command will: | |
| 2. Apply relevant codemods to fix issues | ||
| 3. Report what was changed in each file | ||
| 4. Write updated files back to disk (with --write flag) | ||
| 5. Update prompt and agent files to latest templates (similar to 'init' command) | ||
| 6. Delete deprecated .github/aw/schemas/agentic-workflow.json file if it exists | ||
| 7. Delete old template files from pkg/cli/templates/ (with --write flag) | ||
| 8. Delete old .agent.md files that have been moved to .github/aw/ (with --write flag) | ||
| 5. Delete deprecated .github/aw/schemas/agentic-workflow.json file if it exists | ||
| 6. Delete old template files from pkg/cli/templates/ (with --write flag) | ||
| 7. Delete old workflow-specific .agent.md files from .github/agents/ (with --write flag) | ||
|
Comment on lines
57
to
+60
|
||
|
|
||
| ` + WorkflowIDExplanation + ` | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,7 +40,7 @@ func NewUpgradeCommand() *cobra.Command { | |
| Long: `Upgrade the repository for the latest version of agentic workflows. | ||
|
|
||
| This command: | ||
| 1. Updates all agent and prompt files to the latest templates (like 'init' command) | ||
| 1. Updates the dispatcher agent file to the latest template (like 'init' command) | ||
| 2. Applies automatic codemods to fix deprecated fields in all workflows (like 'fix --write') | ||
| 3. Updates GitHub Actions versions in .github/aw/actions-lock.json (unless --no-actions is set) | ||
| 4. Compiles all workflows to generate lock files (like 'compile' command) | ||
|
|
@@ -56,7 +56,6 @@ The --audit flag skips the normal upgrade process. | |
|
|
||
| The upgrade process ensures: | ||
| - Dispatcher agent is current (.github/agents/agentic-workflows.agent.md) | ||
| - All workflow prompts exist in .github/aw/ (create, update, debug, upgrade) | ||
| - All workflows use the latest syntax and configuration options | ||
| - Deprecated fields are automatically migrated across all workflows | ||
| - GitHub Actions are pinned to the latest versions | ||
|
|
@@ -148,17 +147,17 @@ func runUpgradeCommand(verbose bool, workflowDir string, noFix bool, noCompile b | |
| return err | ||
| } | ||
|
|
||
| // Step 1: Update all agent and prompt files (like init command) | ||
| fmt.Fprintln(os.Stderr, console.FormatInfoMessage("Updating agent and prompt files...")) | ||
| upgradeLog.Print("Updating agent and prompt files") | ||
| // Step 1: Update dispatcher agent file (like init command) | ||
| fmt.Fprintln(os.Stderr, console.FormatInfoMessage("Updating agent file...")) | ||
| upgradeLog.Print("Updating agent file") | ||
|
Comment on lines
+150
to
+152
|
||
|
|
||
| if err := updateAgentFiles(verbose); err != nil { | ||
| upgradeLog.Printf("Failed to update agent files: %v", err) | ||
| return fmt.Errorf("failed to update agent files: %w", err) | ||
| upgradeLog.Printf("Failed to update agent file: %v", err) | ||
| return fmt.Errorf("failed to update agent file: %w", err) | ||
| } | ||
|
|
||
| if verbose { | ||
| fmt.Fprintln(os.Stderr, console.FormatSuccessMessage("✓ Updated agent and prompt files")) | ||
| fmt.Fprintln(os.Stderr, console.FormatSuccessMessage("✓ Updated agent file")) | ||
| } | ||
|
|
||
| // Step 2: Apply codemods to all workflows (unless --no-fix is specified) | ||
|
|
@@ -299,7 +298,7 @@ func runUpgradeCommand(verbose bool, workflowDir string, noFix bool, noCompile b | |
| return nil | ||
| } | ||
|
|
||
| // updateAgentFiles updates all agent and prompt files to the latest templates | ||
| // updateAgentFiles updates the dispatcher agent file to the latest template | ||
| func updateAgentFiles(verbose bool) error { | ||
| // Update dispatcher agent | ||
| if err := ensureAgenticWorkflowsDispatcher(verbose, false); err != nil { | ||
|
|
||
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.
This section says upgrade updates only the dispatcher agent file, but the
gh aw upgradeimplementation also upgrades.github/workflows/copilot-setup-steps.ymlduring step 1. Please document that additional file update here so users know what to expect in diffs/commits.