Skip to content
Closed
Changes from all commits
Commits
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
119 changes: 119 additions & 0 deletions create.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,125 @@ Here ROOT is the location where you found this file. For example,
- "Wrap the Slack MCP server as a reusable component"
- "Design a shared workflow for database queries"

### Use Shared Agentic Workflows

**Load when**: User wants to learn about or use reusable workflow components, imports, orchestration, or monitoring patterns

**Use cases**:

- "What shared components are available?"
- "How do I use orchestration in my workflow?"
- "Show me monitoring patterns"
- "How do I import shared components?"

GitHub Agentic Workflows supports modular, reusable components that can be imported into your workflows. This enables:

- **DRY Principle**: Avoid duplicating configuration across multiple workflows
- **Rapid Development**: Compose workflows by importing pre-built capabilities
- **Separation of Concerns**: Maintain tool configs, permissions, and prompts independently
- **Consistent Patterns**: Use battle-tested components for common patterns

**Common Reusable Components**

**Orchestration** - Coordinate multiple workflows or agents

Import `shared/orchestration.md` when your workflow needs to delegate work to other workflows or AI agents:

```yaml
imports:
- shared/orchestration.md
safe-outputs:
dispatch-workflow:
workflows: [worker-a, worker-b]
max: 10
assign-to-agent:
name: "copilot"
max: 5
```

**Use cases**: Multi-phase initiatives, fan-out work distribution, coordinating specialized workers

**Monitoring** - Track workflow progress in GitHub Projects

Import `shared/projects.md` when your workflow should update project boards:

```yaml
imports:
- shared/projects.md
safe-outputs:
update-project:
project: "https://github.com/orgs/myorg/projects/123"
max: 10
create-project-status-update:
project: "https://github.com/orgs/myorg/projects/123"
max: 1
```

**Use cases**: Tracking workflow-created issues, periodic status updates, operational dashboards

**Reporting** - Consistent report formatting

Import `shared/reporting.md` for standardized report structure:

```yaml
imports:
- shared/reporting.md
```

**Use cases**: Daily/weekly status reports, test results, analysis summaries

**Discovering Available Components**

Repositories using gh-aw often organize shared components in:

- `.github/workflows/shared/` - Core capabilities (reporting, data analysis, tool configs)
- `.github/workflows/shared/mcp/` - MCP server configurations

List available components:

```bash
ls .github/workflows/shared/
```

**Using Imports**

Add imports to your workflow frontmatter:

```yaml
---
on: issues
imports:
- shared/orchestration.md
- shared/projects.md
- shared/mcp/tavily.md
---
```

The compiler merges imported configurations with your workflow's config. See [Packaging & Distribution](/gh-aw/guides/packaging-imports/) for complete details on import behavior and merge semantics.

**Available After Installation**

When you run `gh aw init` in a repository, several helper files become available:

**Workflow Prompt Files** (`.github/aw/`)
- `create-agentic-workflow.md` - Guides creation of new workflows
- `update-agentic-workflow.md` - Guides updates to existing workflows
- `debug-agentic-workflow.md` - Helps debug workflow issues
- `create-shared-agentic-workflow.md` - Creates reusable shared components
- `upgrade-agentic-workflows.md` - Upgrades workflows to new gh-aw versions
- `github-agentic-workflows.md` - GitHub Copilot custom instructions

**Agent Files** (`.github/agents/`)
- `agentic-workflows.agent.md` - Dispatcher agent that routes to appropriate prompts

These files are available for AI assistants to use when helping you create, update, or debug workflows. The `create.md` file (this file) references these prompts and routes you to the appropriate one based on your task.

**Learn More**

- **[Orchestration Guide](/gh-aw/guides/orchestration/)** - Orchestrator/worker pattern for coordinating multiple workflows
- **[Projects & Monitoring Guide](/gh-aw/guides/monitoring/)** - Track workflow activities in GitHub Projects boards
- **[Packaging & Distribution Guide](/gh-aw/guides/packaging-imports/)** - Import system, versioning, and shared components

If you need to clarify requirements or discuss options, and you are working in an interactive agent chat system, do so interactively with the user. If running non-interactively, make reasonable assumptions based on the repository context.

## Step 3: Review Changes
Expand Down