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
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Packaging and Imports
3
3
description: Complete guide to adding, updating, and importing workflows from external repositories using workflow specifications and import directives.
4
4
sidebar:
5
-
order: 6
5
+
order: 600
6
6
---
7
7
8
8
This guide covers the complete workflow for packaging and importing agentic workflows from external repositories, including workflow specifications, CLI commands, and import mechanisms.
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/command-triggers.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Command Triggers
3
3
description: Learn about command triggers and context text functionality for agentic workflows, including special @mention triggers for interactive automation.
4
4
sidebar:
5
-
order: 6
5
+
order: 600
6
6
---
7
7
8
8
GitHub Agentic Workflows add the convenience `command:` trigger to create workflows that respond to `/my-bots` in issues and comments.
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/concurrency.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Concurrency Control
3
3
description: Complete guide to concurrency control in GitHub Agentic Workflows, including agent job concurrency configuration and engine isolation.
4
4
sidebar:
5
-
order: 6
5
+
order: 600
6
6
---
7
7
8
8
GitHub Agentic Workflows provides sophisticated concurrency control to manage how many AI-powered agent jobs can run simultaneously. This helps prevent resource exhaustion, control costs, and ensure predictable workflow execution.
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/custom-safe-outputs.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Custom Safe Outputs
3
3
description: Learn how to create custom safe outputs for third-party integrations using safe-jobs and MCP servers.
4
4
sidebar:
5
-
order: 7
5
+
order: 700
6
6
---
7
7
8
8
Custom safe outputs enable you to extend GitHub Agentic Workflows with your own output processing logic for third-party services like Notion, Slack, Jira, or any custom API. This guide demonstrates how to create reusable, secure integrations using safe-jobs combined with MCP servers.
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/engines.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,11 @@
1
1
---
2
2
title: AI Engines
3
-
description: Complete guide to AI engines available in GitHub Agentic Workflows, including Claude, Copilot, Codex, and custom engines with their specific configuration options.
3
+
description: Complete guide to AI engines (coding agents) usable with GitHub Agentic Workflows, including Claude, Copilot, Codex, and custom engines with their specific configuration options.
4
4
sidebar:
5
-
order: 1
5
+
order: 350
6
6
---
7
7
8
-
GitHub Agentic Workflows support multiple AI engines to interpret and execute natural language instructions. Each engine has unique capabilities and configuration options.
9
-
10
-
## Agentic Engines
8
+
GitHub Agentic Workflows support multiple AI engines (coding agents) to interpret and execute natural language instructions. Each engine has unique capabilities and configuration options.
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/frontmatter.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Frontmatter Options
3
3
description: Complete guide to all available frontmatter configuration options for GitHub Agentic Workflows, including triggers, permissions, AI engines, and workflow settings.
4
4
sidebar:
5
-
order: 2
5
+
order: 200
6
6
---
7
7
8
8
The YAML frontmatter supports standard GitHub Actions properties plus additional agentic-specific options:
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/include-directives.md
+17-51Lines changed: 17 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,12 @@
2
2
title: Imports
3
3
description: Learn how to modularize and reuse workflow components across multiple workflows using the imports field in frontmatter for better organization and maintainability.
4
4
sidebar:
5
-
order: 4
5
+
order: 400
6
6
---
7
7
8
8
The `imports:` field in frontmatter allows you to modularize and reuse workflow components across multiple workflows.
9
9
10
-
## Frontmatter Imports
11
-
12
-
The recommended way to import shared components is using the `imports:` field in the frontmatter:
10
+
Imports can be specified either in frontmatter or in markdown. In frontmatter the `imports:` field is used:
13
11
14
12
```aw wrap
15
13
---
@@ -25,6 +23,20 @@ imports:
25
23
Workflow instructions here...
26
24
```
27
25
26
+
In markdown, use the special `{{'#import ...}}` directive:
27
+
28
+
```aw wrap
29
+
---
30
+
...
31
+
---
32
+
33
+
# Your Workflow
34
+
35
+
Workflow instructions here...
36
+
37
+
{{#import shared/common-tools.md}}
38
+
```
39
+
28
40
### Import Path Resolution
29
41
30
42
-**Relative paths**: Resolved relative to the importing file
@@ -33,35 +45,11 @@ Workflow instructions here...
33
45
34
46
## Frontmatter Merging
35
47
48
+
When importing files, frontmatter fields are merged with the main workflow:
36
49
-**Only `tools:` and `mcp-servers:` frontmatter** is allowed in imported files, other entries give a warning.
37
50
-**Tool merging**: `allowed:` tools are merged across all imported files
38
51
-**MCP server merging**: MCP servers defined in imported files are merged with the main workflow
39
52
40
-
### Example Tool Merging
41
-
```aw wrap
42
-
# Base workflow
43
-
---
44
-
on: issues
45
-
tools:
46
-
github:
47
-
allowed: [get_issue]
48
-
imports:
49
-
- shared/extra-tools.md
50
-
---
51
-
```
52
-
53
-
```aw wrap
54
-
# shared/extra-tools.md
55
-
---
56
-
tools:
57
-
github:
58
-
allowed: [add_issue_comment, update_issue]
59
-
edit:
60
-
---
61
-
```
62
-
63
-
**Result**: Final workflow has `github.allowed: [get_issue, add_issue_comment, update_issue]` and Claude Edit tool.
64
-
65
53
### Example MCP Server Merging
66
54
67
55
```aw wrap
@@ -86,28 +74,6 @@ mcp-servers:
86
74
87
75
**Result**: Final workflow has the Tavily MCP server configured and available to the AI engine.
88
76
89
-
## Legacy Directive Syntax (Deprecated)
90
-
91
-
:::caution[Deprecated]
92
-
The `{{#import}}`, `@import`, and `@include` directive syntax is deprecated. Use the `imports:` field in frontmatter instead.
93
-
94
-
**Migration example:**
95
-
```diff
96
-
# Old approach
97
-
---
98
-
on: issues
99
-
---
100
-
- @import shared/extra-tools.md
101
-
102
-
# New approach
103
-
+ ---
104
-
+ on: issues
105
-
+ imports:
106
-
+ - shared/extra-tools.md
107
-
+ ---
108
-
```
109
-
:::
110
-
111
77
## Related Documentation
112
78
113
79
-[Packaging and Imports](/gh-aw/guides/packaging-imports/) - Complete guide to adding, updating, and importing workflows
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/network.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Network Permissions
3
3
description: Control network access for AI engines using ecosystem identifiers and domain allowlists
4
4
sidebar:
5
-
order: 7
5
+
order: 700
6
6
---
7
7
8
8
Control network access for AI engines using the top-level `network` field. Network permissions provide fine-grained control over which domains and services your agentic workflows can access during execution.
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/safe-jobs.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Safe Jobs
3
3
description: Learn about safe-jobs feature that enables defining custom post-processing workflows with GitHub Actions job properties and artifact access.
4
4
sidebar:
5
-
order: 6
5
+
order: 600
6
6
---
7
7
8
8
The `safe-outputs.jobs:` element of your workflow's frontmatter enables you to define custom post-processing jobs that execute after the main agentic workflow completes. Safe-jobs provide a powerful way to create sophisticated automation workflows while maintaining security through controlled job execution.
0 commit comments