You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/content/docs/guides/packaging-imports.md
+6-144Lines changed: 6 additions & 144 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ The compiler uses a **breadth-first search (BFS)** algorithm to process imports:
61
61
62
62
**Processing order** follows BFS traversal:
63
63
64
-
```
64
+
```text
65
65
Main Workflow
66
66
├── shared/tools.md (1st - direct import)
67
67
│ └── shared/base.md (3rd - nested from tools.md)
@@ -117,84 +117,9 @@ safe-outputs:
117
117
118
118
See [Imports Reference](/gh-aw/reference/imports/) for complete merge semantics.
119
119
120
-
## Importing Agents from Repositories
121
-
122
-
Agent files provide specialized AI instructions and behavior. You can import agents from external repositories to reuse expert-crafted prompts and configurations across teams and projects.
123
-
124
-
### Creating a Shareable Agent
125
-
126
-
Store agent files in `.github/agents/` of any repository:
Teams import agents based on workflow needs, with all agents benefiting from centralized updates and versioning.
122
+
Agent files provide specialized AI instructions and behavior. See [Importing Copilot Custom Agent Files](/gh-aw/reference/copilot-custom-agents/) for details on creating and importing agent files from external repositories.
198
123
199
124
## Example: Modular Workflow with Imports
200
125
@@ -235,62 +160,6 @@ Perform web research using Tavily and respond to issues.
235
160
236
161
**Result**: The compiled workflow includes both the Tavily MCP server from the import and the GitHub tools from the main workflow, with network permissions automatically merged to allow access to both `mcp.tavily.com` and GitHub API endpoints.
237
162
238
-
## Real-World Scenario: Team-Wide Configuration
239
-
240
-
A development team can create a shared configuration repository with reusable components:
Automated code review with security policy enforcement using shared agent.
283
-
```
284
-
285
-
**Benefits**:
286
-
287
-
- **Consistency**: All workflows use same tool configurations and agent behavior
288
-
- **Maintainability**: Update imports once, affects all workflows
289
-
- **Versioning**: Pin to stable versions with semantic tags
290
-
- **Modularity**: Mix and match components and agents as needed
291
-
- **Governance**: Security policies and review standards enforced through imports
292
-
- **Agent Sharing**: Reuse specialized agent instructions across teams and repositories
293
-
294
163
## Specification Formats and Validation
295
164
296
165
Workflow and import specifications require minimum 3 parts (owner/repo/path) for remote imports. Explicit paths must end with `.md`. Versions can be semantic tags (`@v1.0.0`), branches (`@develop`), or commit SHAs. Identifiers use alphanumeric characters with hyphens/underscores (cannot start/end with hyphen).
@@ -300,20 +169,13 @@ Workflow and import specifications require minimum 3 parts (owner/repo/path) for
300
169
- Repository: `owner/repo[@version]`
301
170
- Short workflow: `owner/repo/workflow[@version]`(adds `workflows/` prefix and `.md`)
- Raw URL: `https://raw.githubusercontent.com/owner/repo/refs/heads/main/workflows/ci-doctor.md`
307
176
308
177
## Best Practices
309
178
310
-
Use semantic versioning for stable workflows and agents, branches for development, and commit SHAs for immutability. Organize reusable components in `shared/` directories and agent files in `.github/agents/` with descriptive names. Review updates with `--verbose` before applying, test on branches, and keep local modifications minimal to reduce merge conflicts.
311
-
312
-
When sharing agents across teams:
313
-
314
-
- Use semantic versioning for production agents (`@v1.0.0`)
315
-
- Document agent capabilities and requirements in frontmatter
316
-
- Test agent updates in non-production workflows first
317
-
- Maintain backwards compatibility within major versions
179
+
Use semantic versioning for stable workflows and agent files, branches for development, and commit SHAs for immutability. Organize reusable components in `shared/` directories and agent files in `.github/agents/` with descriptive names. Review updates with `--verbose` before applying, test on branches, and keep local modifications minimal to reduce merge conflicts.
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/frontmatter.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,7 @@ tools:
22
22
23
23
## Frontmatter Elements
24
24
25
-
The frontmatter combines standard GitHub Actions properties (`on`, `permissions`, `run-name`, `runs-on`, `timeout-minutes`, `concurrency`, `env`, `environment`, `container`, `services`, `if`, `steps`, `cache`) with GitHub Agentic Workflows-specific elements (`description`, `source`, `imports`, `engine`, `strict`, `roles`, `features`, `plugins`, `runtimes`, `safe-inputs`, `safe-outputs`, `network`, `tools`).
26
-
27
-
Tool configurations (such as `bash`, `edit`, `github`, `web-fetch`, `web-search`, `playwright`, `cache-memory`, and custom [Model Context Protocol](/gh-aw/reference/glossary/#mcp-model-context-protocol) (MCP) [servers](/gh-aw/reference/glossary/#mcp-server)) are specified under the `tools:` key. Custom inline tools can be defined with the [`safe-inputs:`](/gh-aw/reference/safe-inputs/) (custom tools defined inline) key. See [Tools](/gh-aw/reference/tools/) and [Safe Inputs](/gh-aw/reference/safe-inputs/) for complete documentation.
25
+
Below is a comprehensive reference to all available frontmatter fields for GitHub Agentic Workflows.
0 commit comments