Move orchestration and projects guides to .github/aw as agent prompts#13748
Move orchestration and projects guides to .github/aw as agent prompts#13748
Conversation
…r with optimized content Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@copilot move .github/workflows/shared/project.md as well |
|
|
||
| - **Project tracking / monitoring** (GitHub Projects updates, status reporting) | ||
| - **Orchestration / coordination** (one workflow assigning agents or dispatching and coordinating other workflows) | ||
| - **Observability** (logging, monitoring, and debugging capabilities) |
There was a problem hiding this comment.
@copilot remove observability file and reference
There was a problem hiding this comment.
Done in 26d4553. Removed .github/aw/observability.md and removed the observability reference from the "Workflows may optionally include" list in agentic-workflows.agent.md.
…ompts Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
…kflow Concepts to bottom Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR rehomes the orchestration and GitHub Projects guidance from shared workflow imports into dedicated .github/aw agent prompts, and wires them into the main agentic workflows agent prompt. The goal is to give workflow‑generation agents richer, dedicated instructions for delegation/orchestration and Projects v2 integration without relying on imports: in workflows.
Changes:
- Remove the shared GitHub Projects and Orchestration markdown guides under
.github/workflows/shared/. - Add new agent-focused guides under
.github/aw/projects.mdand.github/aw/orchestration.mdwith expanded “when to use,” configuration, and design‑pattern content. - Update
.github/agents/agentic-workflows.agent.mdto advertise these new prompts with clear load conditions and direct links.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/shared/projects.md |
Removes the old shared Projects v2 guidance that was intended to be imported via workflow imports:. |
.github/workflows/shared/orchestration.md |
Removes the old orchestration/delegation shared guide that was previously imported by workflows. |
.github/aw/projects.md |
Introduces a self‑contained Projects v2 integration prompt for agents, covering when to use, safe‑output config, agent output patterns, and project management best practices. |
.github/aw/orchestration.md |
Introduces an orchestration/delegation prompt for agents, including assign‑to‑agent vs dispatch‑workflow, correlation IDs, and common orchestration patterns. |
.github/agents/agentic-workflows.agent.md |
Adds a “Key Workflow Concepts” section that tells agents when to load the new orchestration and Projects prompts and what they cover, with direct GitHub links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## References | ||
|
|
||
| - For full configuration options, see: [github-agentic-workflows.md](https://github.com/github/gh-aw/blob/main/.github/aw/github-agentic-workflows.md) | ||
| - For safe-outputs documentation, see the `safe-outputs:` section in the main configuration guide |
There was a problem hiding this comment.
Now that the Projects and Orchestration guides have been moved from .github/workflows/shared/ into .github/aw/, the example in create.md still tells users to import github/gh-aw/.github/workflows/shared/projects.md@vX.Y.Z and .../shared/orchestration.md@vX.Y.Z, and also claims these files exist locally under .github/workflows/shared/. That documentation will become incorrect (and the import paths will 404) once this PR lands, so we should update create.md to reference the new .github/aw/ locations or otherwise adjust that snippet to match the new structure.
| - For safe-outputs documentation, see the `safe-outputs:` section in the main configuration guide | |
| - For safe-outputs documentation, see the [`safe-outputs` section](https://github.com/github/gh-aw/blob/main/.github/aw/github-agentic-workflows.md#safe-outputs) in the main configuration guide |
Relocates orchestration and projects patterns to
.github/aw/for use by workflow generation agents. These prompts provide specialized knowledge when agents need to design workflows with delegation or GitHub Projects integration.Changes
File Relocations:
.github/workflows/shared/orchestration.md→.github/aw/orchestration.md.github/workflows/shared/projects.md→.github/aw/projects.mdOrchestration Enhancements:
assign-to-agentvsdispatch-workflowuse casesProjects Integration Content:
Agent Integration:
.github/agents/agentic-workflows.agent.mdwith "Key Workflow Concepts" section at the bottomExample
The dispatcher agent now routes to specialized prompts:
No workflows currently use the old
imports:syntax for these files.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.