Skip to content

Commit 88a8ca3

Browse files
authored
docs: rename assign-to-copilot to copilot-cloud-agent, consolidate create-agent-session (#37149)
- Rename reference/assign-to-copilot.mdx → reference/copilot-cloud-agent.mdx - Consolidate create-agent-session safe output docs into the new page alongside assign-to-agent - New page title: 'Copilot Cloud Agent' covering both safe outputs with shared Auth section - Add redirect /reference/assign-to-copilot/ → /gh-aw/reference/copilot-cloud-agent/ in astro.config.mjs - Update sidebar label/link to 'Safe Outputs (Copilot Cloud Agent)' - Fix all inbound links across safe-outputs.md, auth.mdx, glossary.md, staged-mode.md, safe-outputs-pull-requests.md, research-plan-assign-ops.md
1 parent 2331d48 commit 88a8ca3

8 files changed

Lines changed: 53 additions & 21 deletions

File tree

docs/astro.config.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ export default defineConfig({
9494
// Reference renames
9595
'/reference/custom-agents/': '/gh-aw/reference/copilot-custom-agents/',
9696
'/reference/custom-agent/': '/gh-aw/reference/custom-agent-for-aw/',
97+
'/reference/assign-to-copilot/': '/gh-aw/reference/copilot-cloud-agent/',
9798

9899
// Organization Practices moved under Guides
99100
'/organization-practices/': '/gh-aw/practices/organization-practices/',
@@ -416,7 +417,7 @@ export default defineConfig({
416417
{ label: 'MCP Scripts', link: '/reference/mcp-scripts/' },
417418
{ label: 'MCP Scripts (Spec)', link: '/reference/mcp-scripts-specification/' },
418419
{ label: 'Safe Outputs', link: '/reference/safe-outputs/' },
419-
{ label: 'Safe Outputs (Assign to Copilot)', link: '/reference/assign-to-copilot/' },
420+
{ label: 'Safe Outputs (Copilot Cloud Agent)', link: '/reference/copilot-cloud-agent/' },
420421
{ label: 'Safe Outputs (Custom)', link: '/reference/custom-safe-outputs/' },
421422
{ label: 'Safe Outputs (Pull Requests)', link: '/reference/safe-outputs-pull-requests/' },
422423
{ label: 'Safe Outputs (Spec)', link: '/reference/safe-outputs-specification/' },

docs/src/content/docs/patterns/research-plan-assign-ops.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
badge: { text: 'Multi-phase', variant: 'caution' }
66
---
77

8-
ResearchPlanAssignOps is a four-phase development pattern that moves from automated discovery to merged code with human control at every decision point. A research agent surfaces insights, a planning agent converts them into actionable issues, a coding agent implements the work by [assigning issues to GitHub Copilot](/gh-aw/reference/assign-to-copilot/), and a human reviews and merges.
8+
ResearchPlanAssignOps is a four-phase development pattern that moves from automated discovery to merged code with human control at every decision point. A research agent surfaces insights, a planning agent converts them into actionable issues, a coding agent implements the work by [assigning issues to GitHub Copilot](/gh-aw/reference/copilot-cloud-agent/), and a human reviews and merges.
99

1010
## The Four Phases
1111

@@ -179,4 +179,4 @@ Prefer a simpler pattern when:
179179
- [DispatchOps](/gh-aw/patterns/dispatch-ops/) — Manually triggered research and one-off investigations
180180
- [WorkQueueOps](/gh-aw/patterns/workqueue-ops/) — Sequential queue processing for large backlogs
181181
- [Safe Outputs](/gh-aw/reference/safe-outputs/) — Secure write operations
182-
- [Assign to Copilot](/gh-aw/reference/assign-to-copilot/) — Assigning issues to GitHub Copilot
182+
- [Copilot Cloud Agent](/gh-aw/reference/copilot-cloud-agent/) — Assigning issues to GitHub Copilot

docs/src/content/docs/reference/auth.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Workflows using the following **read** operations from GitHub require [Additiona
3434

3535
Workflows using the following features of [Safe Outputs](/gh-aw/reference/safe-outputs/) require additional authentication, via either a secret containing a PAT or GitHub App:
3636
- [**Safe outputs writing cross-repo**](/gh-aw/reference/safe-outputs/#cross-repository-operations)
37-
- [**Safe outputs assigning Copilot coding agent to issues/PRs**](/gh-aw/reference/assign-to-copilot/)
37+
- [**Safe outputs assigning Copilot coding agent to issues/PRs**](/gh-aw/reference/copilot-cloud-agent/)
3838
- [**Safe outputs updating GitHub Projects**](/gh-aw/patterns/project-ops/#project-token-authentication)
3939
- [**Safe outputs triggering CI on PRs**](/gh-aw/reference/triggering-ci/)
4040

docs/src/content/docs/reference/assign-to-copilot.mdx renamed to docs/src/content/docs/reference/copilot-cloud-agent.mdx

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,50 @@
11
---
2-
title: Assign to Copilot
3-
description: Programmatically assign GitHub Copilot coding agent to issues and pull requests
2+
title: Copilot Cloud Agent
3+
description: Spawn new Copilot cloud agent sessions and assign Copilot to issues and pull requests
44
sidebar:
55
order: 810
66
---
77

88
import Video from '../../../components/Video.astro';
99

10-
This page describes how to programmatically assign the [GitHub Copilot coding agent](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-coding-agent) to issues or pull requests using the `assign-to-agent` safe output. This automates the [standard GitHub workflow for assigning issues to Copilot](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr#assigning-an-issue-to-copilot).
10+
This page covers two safe outputs for invoking the [GitHub Copilot cloud agent](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-coding-agent) from workflows:
1111

12-
## When to Use
12+
- **[`create-agent-session`](#create-agent-session)** — Spawn a new Copilot agent session to work on a task
13+
- **[`assign-to-agent`](#assign-to-agent)** — Assign Copilot to an existing issue or pull request
1314

14-
Use `assign-to-agent` when you need to programmatically assign Copilot coding agent to **existing** issues or PRs through workflow automation.
15+
Both safe outputs require a fine-grained PAT — see [Authentication](#authentication) below.
1516

16-
If you're creating new issues and want to assign Copilot coding agent immediately, use `assignees: copilot` in your [`create-issue`](/gh-aw/reference/safe-outputs/#issue-creation-create-issue) configuration instead.
17+
## Create Agent Session
1718

18-
## Configuration
19+
Creates a new Copilot coding agent session from workflow output, allowing a workflow to spawn follow-up work autonomously. The agent session appears as a GitHub issue that triggers Copilot to implement the described task and open a pull request.
20+
21+
### Configuration
22+
23+
```yaml wrap
24+
safe-outputs:
25+
create-agent-session:
26+
base: "main" # base branch for agent session PR
27+
max: 1 # max sessions (default: 1, maximum: 10)
28+
target-repo: "owner/repo" # cross-repository
29+
allowed-repos: ["org/repo1", "org/repo2"] # additional allowed repositories
30+
github-token: ${{ secrets.GH_AW_AGENT_TOKEN }} # token for permissions
31+
```
32+
33+
### Cross-Repository
34+
35+
`create-agent-session` supports `target-repo` and `allowed-repos` for cross-repository use but does **not** support `target-repo: "*"` — use an explicit `owner/repo` value or `allowed-repos` instead.
36+
37+
## Assign to Agent
38+
39+
Programmatically assigns the GitHub Copilot coding agent to **existing** issues or pull requests through workflow automation. This automates the [standard GitHub workflow for assigning issues to Copilot](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr#assigning-an-issue-to-copilot).
40+
41+
### When to Use
42+
43+
Use `assign-to-agent` when you need to programmatically assign Copilot to **existing** issues or PRs.
44+
45+
If you're creating new issues and want to assign Copilot immediately, use `assignees: copilot` in your [`create-issue`](/gh-aw/reference/safe-outputs/#issue-creation-create-issue) configuration instead.
46+
47+
### Configuration
1948

2049
```yaml wrap
2150
safe-outputs:
@@ -36,27 +65,27 @@ safe-outputs:
3665

3766
**Supported agents:** `copilot` (`copilot-swe-agent`)
3867

39-
## Target Issue or Pull Request
68+
### Target Issue or Pull Request
4069

4170
The `target` parameter determines which issue or PR to assign the agent to:
4271

4372
- `target: "triggering"` (default) - Auto-resolves from `github.event.issue.number` or `github.event.pull_request.number`
4473
- `target: "*"` - Requires explicit `issue_number` or `pull_number` in agent output
4574
- `target: "123"` - Always uses issue/PR #123
4675
47-
## Cross-Repository PR Creation
76+
### Cross-Repository PR Creation
4877
4978
Use `pull-request-repo` to create pull requests in a different repository than where the issue lives — useful when issues are tracked centrally but code lives elsewhere. The issue repository is determined by `target-repo` or defaults to the workflow's repository.
5079

5180
`pull-request-repo` is automatically included in the allowed list; use `allowed-pull-request-repos` for additional repositories. Use `base-branch` to target a specific branch (defaults to the target repo's default branch).
5281

53-
## Assignee Filtering
82+
### Assignee Filtering
5483

5584
When an `allowed` list is configured, existing agent assignees not in the list are removed while regular user assignees are preserved.
5685

5786
## Authentication
5887

59-
This safe output requires a fine-grained PAT to authenticate the agent assignment operation. The default `GITHUB_TOKEN` lacks the necessary permissions.
88+
Both safe outputs require a fine-grained PAT. The default `GITHUB_TOKEN` lacks the necessary permissions.
6089

6190
### Using a Personal Access Token (PAT)
6291

docs/src/content/docs/reference/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,11 +234,11 @@ A safe output capability for removing labels from issues or pull requests. Suppo
234234

235235
### Assign to Agent
236236

237-
A safe output capability (`assign-to-agent:`) that programmatically assigns the GitHub Copilot coding agent to existing issues or pull requests. Automates the standard GitHub workflow for delegating implementation tasks to Copilot. Supports cross-repository PR creation via `pull-request-repo` and agent model selection via `model`. See [Assign to Copilot](/gh-aw/reference/assign-to-copilot/).
237+
A safe output capability (`assign-to-agent:`) that programmatically assigns the GitHub Copilot coding agent to existing issues or pull requests. Automates the standard GitHub workflow for delegating implementation tasks to Copilot. Supports cross-repository PR creation via `pull-request-repo` and agent model selection via `model`. See [Copilot Cloud Agent](/gh-aw/reference/copilot-cloud-agent/).
238238

239239
### GH_AW_AGENT_TOKEN
240240

241-
A recognized "magic" repository secret name that GitHub Agentic Workflows automatically uses as a fallback Personal Access Token for `assign-to-agent` operations. When set, no explicit `github-token:` reference is needed in workflow frontmatter — the token is injected automatically. Required because GitHub App installation tokens are rejected by the Copilot assignment API. The token fallback chain is: `assign-to-agent.github-token` → `safe-outputs.github-token` → `GH_AW_AGENT_TOKEN` → `GH_AW_GITHUB_TOKEN` → `GITHUB_TOKEN`. See [Assign to Copilot](/gh-aw/reference/assign-to-copilot/).
241+
A recognized "magic" repository secret name that GitHub Agentic Workflows automatically uses as a fallback Personal Access Token for `assign-to-agent` operations. When set, no explicit `github-token:` reference is needed in workflow frontmatter — the token is injected automatically. Required because GitHub App installation tokens are rejected by the Copilot assignment API. The token fallback chain is: `assign-to-agent.github-token` → `safe-outputs.github-token` → `GH_AW_AGENT_TOKEN` → `GH_AW_GITHUB_TOKEN` → `GITHUB_TOKEN`. See [Copilot Cloud Agent](/gh-aw/reference/copilot-cloud-agent/).
242242

243243
### Custom Safe Outputs
244244

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ safe-outputs:
323323

324324
**Target**: `"triggering"` (requires PR event), `"*"` (any PR), or number (specific PR).
325325

326-
Use `allowed-reviewers: [copilot]` to assign the Copilot PR reviewer bot. See [Assign to Agent](/gh-aw/reference/assign-to-copilot/).
326+
Use `allowed-reviewers: [copilot]` to assign the Copilot PR reviewer bot. See [Copilot Cloud Agent](/gh-aw/reference/copilot-cloud-agent/).
327327

328328
## Compile-Time Warnings for `target: "*"`
329329

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The agent requests issue creation; a separate job with `issues: write` creates i
7272
- [**Dispatch Repository Event**](#repository-dispatch-dispatch_repository) (`dispatch_repository`) - Trigger `repository_dispatch` events in external repositories, experimental (cross-repo)
7373
- [**Code Scanning Alerts**](#code-scanning-alerts-create-code-scanning-alert) (`create-code-scanning-alert`) - Generate SARIF security advisories (max: unlimited, same-repo only)
7474
- [**Autofix Code Scanning Alerts**](#autofix-code-scanning-alerts-autofix-code-scanning-alert) (`autofix-code-scanning-alert`) - Create automated fixes for code scanning alerts (max: 10, same-repo only)
75-
- [**Create Agent Session**](#agent-session-creation-create-agent-session) (`create-agent-session`) - Create Copilot coding agent sessions (max: 1)
75+
- [**Create Agent Session**](/gh-aw/reference/copilot-cloud-agent/#create-agent-session) (`create-agent-session`) - Create Copilot coding agent sessions (max: 1)
7676

7777
### System Types (Auto-Enabled)
7878

@@ -1311,6 +1311,8 @@ safe-outputs:
13111311
github-token: ${{ secrets.SOME_CUSTOM_TOKEN }} # optional custom token for permissions
13121312
```
13131313

1314+
See **[Copilot Cloud Agent](/gh-aw/reference/copilot-cloud-agent/#create-agent-session)** for full details and authentication setup.
1315+
13141316
### Assign to Agent (`assign-to-agent:`)
13151317

13161318
Programmatically assigns GitHub Copilot coding agent to **existing** issues or pull requests through workflow automation. This safe output automates the [standard GitHub workflow for assigning issues to Copilot](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr#assigning-an-issue-to-copilot).
@@ -1332,7 +1334,7 @@ safe-outputs:
13321334
github-token: ${{ secrets.SOME_CUSTOM_TOKEN }} # optional custom token for permissions
13331335
```
13341336

1335-
See **[Assign to Copilot](/gh-aw/reference/assign-to-copilot/)** for complete configuration options and authorization setup.
1337+
See **[Copilot Cloud Agent](/gh-aw/reference/copilot-cloud-agent/#assign-to-agent)** for complete configuration options and authorization setup.
13361338

13371339
If you're creating new issues and want to assign an agent immediately, use `assignees: copilot` in your [`create-issue`](#issue-creation-create-issue) configuration instead.
13381340

docs/src/content/docs/reference/staged-mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Staged mode is supported by all built-in safe output types:
105105
| [`dispatch-workflow`](/gh-aw/reference/safe-outputs/#workflow-dispatch-dispatch-workflow) | Target workflow, inputs |
106106
| [`assign-to-agent`](/gh-aw/reference/safe-outputs/#assign-to-agent-assign-to-agent) | Target issue/PR |
107107
| [`assign-to-user`](/gh-aw/reference/safe-outputs/#assign-to-user-assign-to-user) | Target item, user |
108-
| [`create-agent-session`](/gh-aw/reference/safe-outputs/#agent-session-creation-create-agent-session) | Session details |
108+
| [`create-agent-session`](/gh-aw/reference/copilot-cloud-agent/#create-agent-session) | Session details |
109109

110110
[Custom safe output jobs](/gh-aw/reference/custom-safe-outputs/) receive the `GH_AW_SAFE_OUTPUTS_STAGED` environment variable set to `"true"` when staged mode is active, allowing you to implement your own preview behavior.
111111

0 commit comments

Comments
 (0)