Skip to content

Commit d84d12b

Browse files
CopilottimrogersSiaraMist
authored
Restructure Copilot cloud agent docs into client-focused articles (#61355)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: timrogers <116134+timrogers@users.noreply.github.com> Co-authored-by: Tim Rogers <me@timrogers.co.uk> Co-authored-by: SiaraMist <siaramist@github.com> Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
1 parent 64b3807 commit d84d12b

27 files changed

Lines changed: 934 additions & 877 deletions

content/code-security/tutorials/improve-code-quality/improve-recent-merges.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ There is a delay while the {% data variables.copilot.copilot_cloud_agent_short %
7272
You can track {% data variables.copilot.copilot_cloud_agent %}'s work:
7373

7474
* In the pull request, the summary is updated as work progresses.
75-
* Using the [agents page](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text) or session logs. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions).
75+
* Using the [agents page](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text) or session logs. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents).
7676

7777
### Open your own pull requests
7878

content/copilot/concepts/agents/cloud-agent/agent-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ From the Agents tab, you can:
3737
* **Kick off new agent tasks**: Select an AI model of your choice, and optionally choose from third-party agents or {% data variables.copilot.custom_agents_short %} best suited for the task. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions).
3838
* **Monitor live session logs**: Once the agent starts working, you can click any agent session to open the session log and follow its progress and thought process in real time.
3939
* **Track active sessions**: You can view all active agent sessions that have been started in the repository.
40-
* **Steer agents mid-session**: If you realize you didn't scope a request correctly, or want the agent to use a specific tool or service, you can step in and provide **steering input** without stopping the run. Steering uses **one premium request** per message. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions#steering-a-copilot-session-from-the-agents-tab).
40+
* **Steer agents mid-session**: If you realize you didn't scope a request correctly, or want the agent to use a specific tool or service, you can step in and provide **steering input** without stopping the run. Steering uses **one premium request** per message. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents#steer-an-agent-session).
4141
* **Open a session in {% data variables.product.prodname_vscode_shortname %} or {% data variables.copilot.copilot_cli %}**: When you want to start working on changes to an agent session in your local development environment, click **{% octicon "vscode" aria-label="VS Code" %} Open in {% data variables.product.prodname_vscode_shortname %}** or **{% octicon "agent" aria-label="Agent" %} Continue in {% data variables.copilot.copilot_cli %}** to bring the session to your local machine.
4242
{% data reusables.copilot.cloud-agent.use-latest-vscode %}
4343
* **Review and merge agent code**: Once the agent completes a session, you can jump to the pull request to review the changes, request further improvements, or approve and merge. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs).

content/copilot/concepts/agents/cloud-agent/risks-and-mitigations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Where possible, {% data variables.product.github %} has applied appropriate miti
2424
* **{% data variables.product.prodname_codeql %}** is used to identify code security issues.
2525
* Newly introduced dependencies are checked against the **{% data variables.product.prodname_advisory_database %}** for malware advisories, and for any CVSS-rated High or Critical vulnerabilities.
2626
* **{% data variables.product.prodname_secret_scanning_caps %}** is used to detect sensitive information such as API keys, tokens, and other secrets.
27-
* Details about the analysis performed and the actions taken by {% data variables.copilot.copilot_cloud_agent %} can be reviewed in the session log. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions).
27+
* Details about the analysis performed and the actions taken by {% data variables.copilot.copilot_cloud_agent %} can be reviewed in the session log. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents).
2828

2929
Optionally, you can disable one or more of the code quality and security validation tools used by {% data variables.copilot.copilot_cloud_agent %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/configuring-agent-settings).
3030

@@ -58,4 +58,4 @@ To mitigate this risk, {% data variables.copilot.copilot_cloud_agent %} is desig
5858
* {% data variables.copilot.copilot_cloud_agent %}'s commits are authored by {% data variables.product.prodname_copilot_short %}, with the developer who assigned the issue or requested the change to the pull request marked as the co-author. This makes it easier to identify code generated by {% data variables.copilot.copilot_cloud_agent %} and who started the task.
5959
* {% data variables.copilot.copilot_cloud_agent %}'s commits are signed, so they appear as "Verified" on {% data variables.product.github %}. This provides confidence that the commits were made by {% data variables.copilot.copilot_cloud_agent %} and have not been altered.
6060
* Session logs and audit log events are available to administrators.
61-
* The commit message for each agent-authored commit includes a link to the agent session logs, for code review and auditing. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions).
61+
* The commit message for each agent-authored commit includes a link to the agent session logs, for code review and auditing. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents).

content/copilot/concepts/completions/code-referencing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ If you, or your organization, have allowed suggestions that match public code, t
5656
5757
### Code referencing for {% data variables.copilot.copilot_cloud_agent %}
5858

59-
When {% data variables.product.prodname_copilot_short %} generates code that matches code in a public {% data variables.product.github %} repository, this is indicated in the agent session logs with a link to display details of the matched code. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions).
59+
When {% data variables.product.prodname_copilot_short %} generates code that matches code in a public {% data variables.product.github %} repository, this is indicated in the agent session logs with a link to display details of the matched code. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents).
6060

6161
{% endwebui %}
6262

content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Your `copilot-setup-steps.yml` file will automatically be run as a normal {% dat
9898

9999
Once you have merged the yml file into your default branch, you can manually run the workflow from the repository's **Actions** tab at any time to check that everything works as expected. For more information, see [AUTOTITLE](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow).
100100

101-
When {% data variables.product.prodname_copilot_short %} starts work, your setup steps will be run, and updates will show in the session logs. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions).
101+
When {% data variables.product.prodname_copilot_short %} starts work, your setup steps will be run, and updates will show in the session logs. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents).
102102

103103
If any setup step fails by returning a non-zero exit code, {% data variables.product.prodname_copilot_short %} will skip the remaining setup steps and begin working with the current state of its development environment.
104104

content/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
11
---
2-
title: Manage and track {% data variables.copilot.copilot_cloud_agent %} sessions
3-
shortTitle: Manage and track agents
4-
intro: 'Monitor your agent''s progress in real time, steer it with follow-up prompts, and stop or archive sessions.'
5-
product: '{% data reusables.gated-features.copilot-cloud-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
2+
title: Managing agent sessions
3+
shortTitle: Manage agent sessions
4+
intro: 'Monitor an agent''s progress in real time, steer it with follow-up prompts, and stop or archive sessions.'
65
versions:
76
feature: copilot
87
contentType: how-tos
8+
allowTitleToDifferFromFilename: true
99
category:
1010
- Author and optimize with Copilot
1111
redirect_from:
1212
- /copilot/how-tos/use-copilot-agents/manage-agents
13+
- /copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions
14+
- /copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions
15+
- /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs
16+
- /copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs
17+
- /copilot/how-tos/agents/copilot-coding-agent/using-the-copilot-coding-agent-logs
18+
- /copilot/how-tos/agents/copilot-coding-agent/tracking-copilots-sessions
19+
- /copilot/how-tos/agents/copilot-coding-agent/track-copilot-sessions
20+
- /copilot/how-tos/agents/coding-agent/track-copilot-sessions
1321
---
1422

15-
Use the agents panel on {% data variables.product.github %} to start, monitor, and manage agent sessions across your repositories.
23+
Use the agents panel on {% data variables.product.github %} to monitor and manage agent sessions across your repositories.
1624

1725
## Monitor agent activity
1826

content/copilot/how-tos/copilot-on-github/use-copilot-agents/review-copilot-output.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Review output from {% data variables.product.prodname_copilot_short %}
33
shortTitle: Review {% data variables.product.prodname_copilot_short %} output
44
allowTitleToDifferFromFilename: true
5-
intro: '{% data variables.product.prodname_copilot_short %} pull requests deserve the same thorough review as any contribution. Mention `@copilot` to request changes, or push commits directly to the branch.'
5+
intro: '{% data variables.product.prodname_copilot_short %} pull requests deserve the same thorough review as any contribution.'
66
product: '{% data reusables.gated-features.copilot-cloud-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=engagement&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
77
versions:
88
feature: copilot
@@ -14,9 +14,6 @@ redirect_from:
1414
- /copilot/how-tos/agents/copilot-coding-agent/reviewing-a-pull-request-created-by-copilot
1515
- /copilot/how-tos/agents/copilot-coding-agent/review-copilot-prs
1616
- /copilot/how-tos/agents/coding-agent/review-copilot-prs
17-
- /copilot/how-tos/copilot-on-github/use-copilot-agents/iterate-with-copilot
18-
- /copilot/how-tos/use-copilot-agents/coding-agent/make-changes-to-an-existing-pr
19-
- /copilot/how-tos/use-copilot-agents/cloud-agent/make-changes-to-an-existing-pr
2017
contentType: how-tos
2118
category:
2219
- Author and optimize with Copilot
@@ -29,26 +26,7 @@ When {% data variables.product.prodname_copilot_short %} finishes a coding task
2926
> [!IMPORTANT]
3027
> If your repository requires pull request approvals, **your approval of a {% data variables.product.prodname_copilot_short %} pull request won't count** toward the required number. Another reviewer must approve the pull request before it can be merged.
3128
32-
Mention `@copilot` in a pull request comment to request changes. By default, {% data variables.product.prodname_copilot_short %} pushes commits directly to the pull request branch. To create a separate pull request instead, describe that in your comment. You can also check out the branch and push changes yourself.
33-
34-
Batch review comments instead of submitting them individually. When submitting a pull request comment (not a review or review comment) through the {% data variables.product.github %} web interface, select a model with the model picker. {% data variables.product.prodname_copilot_short %} uses the model from the original pull request by default.
35-
36-
{% data reusables.copilot.cloud-agent.write-access-required %}
37-
38-
When {% data variables.product.prodname_copilot_short %} starts a new session in response to your comment, an eyes emoji (👀) reaction appears on the comment. A "Copilot has started work" event appears in the pull request timeline.
39-
40-
![Screenshot of a pull request timeline with a review comment with the eyes reaction and a "Copilot started work" timeline event.](/assets/images/help/copilot/cloud-agent/comment-to-agent-on-pr.png)
41-
42-
{% data variables.product.prodname_copilot_short %} remembers context from previous sessions on the same pull request, so follow-up requests are faster and more reliable. If the pull request was created by a {% data variables.copilot.copilot_custom_agent_short %}, mentioning `@copilot` continues using that same agent.
43-
44-
## Resolve merge conflicts
45-
46-
You can ask {% data variables.product.prodname_copilot_short %} to resolve merge conflicts on a pull request in two ways:
47-
48-
* **Using the "Fix with {% data variables.product.prodname_copilot_short %}" button**: If a pull request has merge conflicts, click the **Fix with {% data variables.product.prodname_copilot_short %}** button that appears in the merge box.
49-
* **Using an @copilot mention**: Mention `@copilot` in a comment on the pull request and ask it to fix the conflicts—for example, "@copilot resolve the merge conflicts on this PR."
50-
51-
{% data variables.product.prodname_copilot_short %} analyzes the conflicting changes, resolves them, and verifies that the build, tests, and linter still pass. It then requests your review so you can confirm the resolution before merging.
29+
To request changes from {% data variables.product.prodname_copilot_short %} on its pull request, mention `@copilot` in a comment, or push commits directly to the branch. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-on-github).
5230

5331
## Manage {% data variables.product.prodname_actions %} workflow runs
5432

content/copilot/how-tos/get-code-suggestions/find-matching-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ To see details of the matching code:
233233

234234
## View code references for {% data variables.copilot.copilot_cloud_agent %}
235235

236-
When {% data variables.product.prodname_copilot_short %} provides a response that includes code that matches code in a public {% data variables.product.github %} repository, this is indicated in the agent session logs with a link to display details of the matched code. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions).
236+
When {% data variables.product.prodname_copilot_short %} provides a response that includes code that matches code in a public {% data variables.product.github %} repository, this is indicated in the agent session logs with a link to display details of the matched code. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents).
237237

238238
{% endwebui %}
239239

0 commit comments

Comments
 (0)