Skip to content

Commit c5cccdc

Browse files
github-actions[bot]mnkiefer
authored andcommitted
docs: document temporary IDs for issue creation and lockdown mode for GitHub tool (#4722)
1 parent b48ab64 commit c5cccdc

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

docs/src/content/docs/reference/safe-outputs.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,30 @@ safe-outputs:
8888
target-repo: "owner/repo" # cross-repository
8989
```
9090

91+
#### Temporary IDs for Issue References
92+
93+
When creating multiple issues, use temporary IDs to reference parent issues before they're created. The agent provides a `temporary_id` field with format `aw_` followed by 12 hex characters.
94+
95+
**Agent Output Format:**
96+
```json
97+
[
98+
{
99+
"type": "create_issue",
100+
"title": "Parent Issue",
101+
"body": "This is the parent issue",
102+
"temporary_id": "aw_abc123def456"
103+
},
104+
{
105+
"type": "create_issue",
106+
"title": "Sub Issue",
107+
"body": "References #aw_abc123def456",
108+
"parent": "aw_abc123def456"
109+
}
110+
]
111+
```
112+
113+
References like `#aw_abc123def456` in issue bodies are automatically replaced with the actual issue number (e.g., `#42`) after the parent issue is created. The `parent` field creates a sub-issue relationship.
114+
91115
### Close Issue (`close-issue:`)
92116

93117
Closes GitHub issues with an optional comment and state reason. Filters by labels and title prefix control which issues can be closed.

docs/src/content/docs/reference/tools.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,16 @@ tools:
126126
read-only: true
127127
```
128128

129+
**Lockdown Mode**: Limit content from public repositories to items authored by users with push access. Private repositories and collaborator-owned content remain unaffected:
130+
131+
```yaml wrap
132+
tools:
133+
github:
134+
lockdown: true
135+
```
136+
137+
Lockdown mode filters issue comments, sub-issues, and PR content to prevent exposure of potentially untrusted content from public repositories. Useful for security-sensitive workflows processing public repository data.
138+
129139
## Playwright Tool (`playwright:`)
130140

131141
Enables browser automation using containerized Playwright with domain-based access control:

0 commit comments

Comments
 (0)