diff --git a/content/admin/overview/establishing-a-governance-framework-for-your-enterprise.md b/content/admin/overview/establishing-a-governance-framework-for-your-enterprise.md index 2e357e0e12a6..607bd3342298 100644 --- a/content/admin/overview/establishing-a-governance-framework-for-your-enterprise.md +++ b/content/admin/overview/establishing-a-governance-framework-for-your-enterprise.md @@ -64,7 +64,7 @@ Other policies are available as blanket restrictions. These give you more contro ## Targeting policies with metadata -You can enable better governance through automated policy enforcement. This is possible with custom properties, allowing you to add structured metadata to your resources. See [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/custom-properties). +You can enable better governance through automated policy enforcement. This is possible with custom properties, allowing you to add structured metadata to your resources.{% ifversion ghec or ghes > 3.20 %} See [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/custom-properties).{% endif %} With **repository custom properties**, you can classify repositories by attributes like risk level, team ownership, or compliance requirements. This metadata enables you to automatically apply different governance rules based on repository characteristics. @@ -72,7 +72,7 @@ With **organization custom properties**, you can categorize organizations within Both types of custom properties integrate with rulesets, allowing you to create powerful governance frameworks that automatically enforce the right policies based on metadata rather than manual repository selection. -See [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization) and [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/managing-custom-properties-for-organizations). +See [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization){% ifversion ghec or ghes > 3.20 %} and [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/managing-custom-properties-for-organizations){% endif %}. ## Monitoring activity diff --git a/content/copilot/concepts/agents/about-third-party-agents.md b/content/copilot/concepts/agents/about-third-party-agents.md new file mode 100644 index 000000000000..6cf4e25673f8 --- /dev/null +++ b/content/copilot/concepts/agents/about-third-party-agents.md @@ -0,0 +1,60 @@ +--- +title: About third-party agents +shortTitle: Third-party agents +intro: 'You can incorporate coding agents into your development workflows on {% data variables.product.github %}.' +product: '{% data reusables.gated-features.third-party-agents %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +topics: + - Copilot +contentType: concepts +--- + +> [!NOTE] Third-party coding agents are currently in {% data variables.release-phases.public_preview %}. + +## Introduction + +You can use third-party coding agents alongside {% data variables.copilot.copilot_coding_agent %} to work asynchronously on your development tasks. You can assign an existing issue or give a prompt to an agent, which will work on the required changes and create a pull request. When the agent finishes, it will request a review from you, and you can leave pull request comments to ask the agent to iterate. + +Coding agents are subject to the same security protections, mitigations, and limitations as {% data variables.copilot.copilot_coding_agent %}. To learn more about how you can use coding agents, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent). + +### Where you can use coding agents + +You can kick off tasks with coding agents in the following locations: + +* **The Agents tab**: Select an agent under the prompt box in the [Agents tab](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text&utm_source=docs-3p-agents-tab-cta&utm_medium=docs&utm_campaign=agent-3p-platform-feb-2026), then kick off a new task and watch the agent get to work on a pull request. +* **Issues**: Assign the agent to an existing issue in a repository. +* **Pull requests**: Mention `@AGENT_NAME` in a comment on an existing pull request to ask it to make changes. +* On [**{% data variables.product.prodname_mobile %}**](/copilot/how-tos/chat-with-copilot/chat-in-mobile): From the **Home** view, click {% octicon "plus" aria-hidden="true" aria-label="plus" %} to start a new agent session. +* In [**{% data variables.product.prodname_vscode %}**](https://code.visualstudio.com/docs/copilot/agents/overview#_create-an-agent-session): Start a new session in the chat view, or delegate an existing session to a different agent. + +### Making coding agents available + +> [!NOTE] +> * {% data reusables.gated-features.third-party-agents %} + +Before you can assign tasks to coding agents, they must be enabled. If you are a {% data variables.copilot.copilot_pro_plus %} subscriber, see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-third-party-agents-in-your-repositories). + +For {% data variables.copilot.copilot_for_business %} and {% data variables.copilot.copilot_enterprise %} subscribers, the ability to use {% data variables.copilot.copilot_coding_agent %} is controlled by policy settings defined at the organization level. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies). + +If the organization is owned by an enterprise, enablement may be controlled at the enterprise level. See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). + +## Supported coding agents + +The following third-party agents are supported on {% data variables.product.github %}: + +* [{% data variables.product.prodname_anthropic_claude %}](/copilot/concepts/agents/anthropic-claude) +* [{% data variables.product.prodname_openai_codex %}](/copilot/concepts/agents/openai-codex) + +## Usage costs + +Coding agents consume **{% data variables.product.prodname_actions %} minutes** and **{% data variables.product.prodname_copilot %} premium requests**. Each agent **session** consumes one premium request. + +Within your monthly usage allowance for {% data variables.product.prodname_actions %} and premium requests, you can ask agents to work on coding tasks without incurring any additional costs. + +For more information, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot). + +## Next steps + +* To start managing agents, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/manage-agents). +* To learn how AI models are hosted and served, see [AUTOTITLE](/copilot/reference/ai-models/model-hosting). \ No newline at end of file diff --git a/content/copilot/concepts/agents/anthropic-claude.md b/content/copilot/concepts/agents/anthropic-claude.md new file mode 100644 index 000000000000..50cc23935a45 --- /dev/null +++ b/content/copilot/concepts/agents/anthropic-claude.md @@ -0,0 +1,23 @@ +--- +title: Anthropic Claude +shortTitle: Anthropic Claude +intro: 'Use the {% data variables.product.prodname_anthropic_claude %} coding agent powered by {% data variables.product.prodname_copilot_short %}.' +product: '{% data reusables.gated-features.anthropic-claude %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +topics: + - Copilot +contentType: concepts +--- + +> [!NOTE] The {% data variables.product.prodname_anthropic_claude %} coding agent is currently in {% data variables.release-phases.public_preview %}. + +## Introduction + +The {% data variables.product.prodname_anthropic_claude %} coding agent uses the Claude Agent SDK and can be powered by your existing {% data variables.product.prodname_copilot_short %} subscription. For information about {% data variables.product.prodname_anthropic_claude %}, see the [{% data variables.product.prodname_anthropic_claude %} documentation](https://platform.claude.com/docs/en/agent-sdk/overview). + +## {% data variables.product.prodname_anthropic_claude %} coding agent + +Before you can assign tasks to {% data variables.product.prodname_anthropic_claude %} coding agent, it must be enabled. See [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-third-party-agents-in-your-repositories). + +To learn more about using third-party coding agents, see [AUTOTITLE](/copilot/concepts/agents/about-third-party-agents). diff --git a/content/copilot/concepts/agents/coding-agent/agent-management.md b/content/copilot/concepts/agents/coding-agent/agent-management.md index cb8a0541743d..7186ffa9ef42 100644 --- a/content/copilot/concepts/agents/coding-agent/agent-management.md +++ b/content/copilot/concepts/agents/coding-agent/agent-management.md @@ -1,7 +1,7 @@ --- title: About agent management shortTitle: Agent management -intro: 'Use one centralized control page to jump between {% data variables.copilot.copilot_coding_agent %} sessions, check progress, and stay in control without losing your place.' +intro: 'Use one centralized control page to jump between agent sessions, check progress, and stay in control without losing your place.' product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot @@ -19,7 +19,9 @@ category: AI agents are autonomous systems that can evaluate their environment, make decisions, and take actions to complete tasks. Agents can break down complex tasks into steps, use various tools and resources, plan their approach, and adapt based on human feedback until they accomplish their assigned objective. -{% data variables.copilot.copilot_coding_agent %} brings automation and assistance to every stage of the software development process on {% data variables.product.github %}. You can run multiple sessions of {% data variables.copilot.copilot_coding_agent %} concurrently, allowing you to efficiently delegate work items. +Agents bring automation and assistance to every stage of the software development process on {% data variables.product.github %}. You can run multiple agent sessions concurrently, allowing you to efficiently delegate work items. + +Alongside {% data variables.product.prodname_copilot_short %}, you can use {% data variables.product.prodname_anthropic_claude %} and {% data variables.product.prodname_openai_codex %}, giving you more flexibility and choice to find the right agent for a task. See [AUTOTITLE](/copilot/concepts/agents/about-third-party-agents). Utilizing {% data variables.copilot.custom_agents_short %} you can build out a team of task-specific agents with customized system prompts to handle simpler tasks like writing tests and refactoring, giving you bandwidth to prioritize problem-solving and collaboration. See [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). @@ -33,13 +35,13 @@ To learn more about {% data variables.copilot.copilot_coding_agent %}, see [AUTO From the Agents tab, you can: -* **Kick off new agent tasks**: Select an AI model of your choice, and optionally choose from {% data variables.copilot.custom_agents_short %} best suited for the task. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr). -* **Monitor live session logs**: Once {% data variables.product.prodname_copilot_short %} starts working, you can click any agent session to open the session log and follow its progress and thought process in real time. +* **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/coding-agent/create-a-pr). +* **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. * **Track active sessions**: You can view all active agent sessions that have been started in the repository. -* **Steer agents mid-session**: If you realize you didn't scope a request correctly, or want {% data variables.product.prodname_copilot_short %} 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/coding-agent/track-copilot-sessions#steering-a-copilot-session-from-the-agents-tab). +* **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/coding-agent/track-copilot-sessions#steering-a-copilot-session-from-the-agents-tab). * **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. {% data reusables.copilot.coding-agent.use-latest-vscode %} -* **Review and merge agent code**: Once {% data variables.product.prodname_copilot_short %} 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/coding-agent/review-copilot-prs). +* **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/coding-agent/review-copilot-prs). ## Next steps diff --git a/content/copilot/concepts/agents/index.md b/content/copilot/concepts/agents/index.md index a45bb46ae71a..098d22a8124e 100644 --- a/content/copilot/concepts/agents/index.md +++ b/content/copilot/concepts/agents/index.md @@ -12,7 +12,9 @@ children: - /code-review - /about-copilot-cli - /copilot-memory + - /about-third-party-agents - /openai-codex + - /anthropic-claude - /about-agent-skills - /enterprise-management contentType: concepts diff --git a/content/copilot/concepts/agents/openai-codex.md b/content/copilot/concepts/agents/openai-codex.md index 2875ea15f2c5..1c4717bf47b2 100644 --- a/content/copilot/concepts/agents/openai-codex.md +++ b/content/copilot/concepts/agents/openai-codex.md @@ -2,8 +2,8 @@ title: OpenAI Codex shortTitle: OpenAI Codex allowTitleToDifferFromFilename: true -intro: 'Use the {% data variables.product.prodname_openai_codex %} Visual Studio Code extension powered by {% data variables.product.prodname_copilot_short %}.' -product: '{% data reusables.gated-features.openai-codex %}' +intro: 'Use the {% data variables.product.prodname_openai_codex %} coding agent and Visual Studio Code extension powered by {% data variables.product.prodname_copilot_short %}.' +product: '{% data reusables.gated-features.openai-codex %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot topics: @@ -17,8 +17,18 @@ category: ## Introduction -The {% data variables.product.prodname_openai_codex %} {% data variables.product.prodname_vscode_shortname %} extension can be powered by your existing {% data variables.product.prodname_copilot_short %} subscription. Use "Sign in with {% data variables.product.prodname_copilot_short %}" when launching the extension. {% data variables.product.prodname_copilot_short %} users can see this integration in the [Agent Sessions view](https://code.visualstudio.com/docs/copilot/chat/chat-sessions#_agent-sessions-view?ref_product=copilot&ref_type=engagement&ref_style=text) in {% data variables.product.prodname_vscode_shortname %} Insiders along with progress on their running tasks. All usage is subject to GitHub rate limits and billing. See [AUTOTITLE](/copilot/concepts/billing/copilot-requests#premium-features). +The {% data variables.product.prodname_openai_codex %} coding agent and the {% data variables.product.prodname_vscode_shortname %} {% data variables.product.prodname_openai_codex %} integration use the Codex SDK and can be powered by your existing {% data variables.product.prodname_copilot_short %} subscription. For more information about how {% data variables.product.prodname_openai_codex %} works, see the [{% data variables.product.prodname_openai_codex %} documentation](https://developers.openai.com/codex). -## Model availability +## {% data variables.product.prodname_openai_codex %} coding agent -A subset of available models may only be available in the OpenAI Codex extension. Model availability and visibility is not governed by {% data variables.product.prodname_copilot_short %} model configuration policies. +Before you can assign tasks to {% data variables.product.prodname_openai_codex %} coding agent, it must be enabled. See [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-third-party-agents-in-your-repositories). + +To learn more about using third-party agents on {% data variables.product.github %}, see [AUTOTITLE](/free-pro-team@latest/copilot/concepts/agents/about-third-party-agents). + +## {% data variables.product.prodname_vscode_shortname %} extension + + Use "Sign in with {% data variables.product.prodname_copilot_short %}" when launching the extension. {% data variables.product.prodname_copilot_short %} users can see this integration in the [Agent Sessions view](https://code.visualstudio.com/docs/copilot/chat/chat-sessions#_agent-sessions-view) in {% data variables.product.prodname_vscode_shortname %} Insiders along with progress on their running tasks. All usage is subject to {% data variables.product.github %} rate limits and billing. See [AUTOTITLE](/copilot/concepts/billing/copilot-requests#premium-features). + +### Model availability + +A subset of available models may only be available in the {% data variables.product.prodname_openai_codex %} extension. Model availability and visibility is not governed by {% data variables.product.prodname_copilot_short %} model configuration policies. diff --git a/content/copilot/concepts/billing/copilot-requests.md b/content/copilot/concepts/billing/copilot-requests.md index 1dd22e79ec74..a60aa89deee1 100644 --- a/content/copilot/concepts/billing/copilot-requests.md +++ b/content/copilot/concepts/billing/copilot-requests.md @@ -45,7 +45,9 @@ The following {% data variables.product.prodname_copilot_short %} features can u | [{% data variables.copilot.copilot_coding_agent %}](/copilot/concepts/about-copilot-coding-agent) | {% data variables.copilot.copilot_coding_agent %} uses **one premium request** per session, multiplied by the model's rate. A session begins when you ask {% data variables.product.prodname_copilot_short %} to create a pull request or make one or more changes to an existing pull request. In addition, each real-time steering comment made during an active session uses **one premium request** per session, multiplied by the model's rate. | {% data variables.copilot.copilot_coding_agent %} premium requests | | [{% data variables.copilot.copilot_spaces %}](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces) | {% data variables.copilot.copilot_spaces %} uses **one premium request** per user prompt, multiplied by the model's rate. | {% data variables.product.prodname_copilot_short %} premium requests | | [{% data variables.product.prodname_spark_short %}](/copilot/tutorials/building-ai-app-prototypes) | Each prompt to {% data variables.product.prodname_spark_short %} uses a fixed rate of **four premium requests**. | {% data variables.product.prodname_spark_short %} premium requests | -| [{% data variables.product.prodname_openai_codex %} integration](/copilot/concepts/agents/openai-codex) | While in preview, each prompt to {% data variables.product.prodname_openai_codex %} uses **one premium request** multiplied by the model multiplier rates. | {% data variables.product.prodname_copilot_short %} premium requests | +| [{% data variables.product.prodname_openai_codex %} {% data variables.product.prodname_vscode %} integration](/copilot/concepts/agents/openai-codex) | While in preview, each prompt to {% data variables.product.prodname_openai_codex %} uses **one premium request** multiplied by the model multiplier rates. | {% data variables.product.prodname_copilot_short %} premium requests | +| [Third-party coding agents](/free-pro-team@latest/copilot/concepts/agents/about-third-party-agents) | While in preview, each prompt to a third-party coding agent uses **one premium request**. | {% data variables.product.prodname_copilot_short %} premium requests | + > [!TIP] > For instructions on viewing how many premium requests you have used and advice on how to optimize usage, see [AUTOTITLE](/copilot/how-tos/manage-and-track-spending/monitor-premium-requests). diff --git a/content/copilot/get-started/features.md b/content/copilot/get-started/features.md index fe0da3c66c90..49afa8b00b38 100644 --- a/content/copilot/get-started/features.md +++ b/content/copilot/get-started/features.md @@ -33,6 +33,10 @@ A chat interface that lets you ask coding-related questions. {% data variables.c An autonomous AI agent that can make code changes for you. You can assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %} and the agent will work on making the required changes, and will create a pull request for you to review. You can also ask {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent). +### Third-party coding agents ({% data variables.release-phases.public_preview %}) + +You can use third-party coding agents alongside {% data variables.copilot.copilot_coding_agent %}. See [AUTOTITLE](/free-pro-team@latest/copilot/concepts/agents/about-third-party-agents). + ### {% data variables.copilot.copilot_cli_short %} ({% data variables.release-phases.public_preview %}) A command line interface that lets you use {% data variables.product.prodname_copilot_short %} from within the terminal. You can get answers to questions, or you can ask {% data variables.product.prodname_copilot_short %} to make changes to your local files. You can also use {% data variables.copilot.copilot_cli_short %} to interact with {% data variables.product.prodname_dotcom_the_website %}—for example, listing your open pull requests, or asking {% data variables.product.prodname_copilot_short %} to create an issue. See [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli). diff --git a/content/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies.md b/content/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies.md index af7f21c89afa..64816c30047f 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies.md @@ -44,6 +44,26 @@ category: {% data reusables.copilot.mcp-servers-policy-note %} +## Enabling or disabling third-party coding agents in your repositories + +> [!NOTE] +> * {% data reusables.gated-features.third-party-agents %} + +You can choose whether to allow the following coding agents to be enabled in your organization: + +* {% data variables.product.prodname_anthropic_claude %} +* {% data variables.product.prodname_openai_codex %} + +Coding agents have access to the same repositories that {% data variables.copilot.copilot_coding_agent %} has been enabled in. + +To enable coding agents: + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.copilot.coding-agent-settings %} +1. In the sidebar, under **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}**, click **Coding agent**. +1. On the {% data variables.copilot.copilot_coding_agent %} page, under "Partner agents", click the toggle to enable the third-party agent you want to use. + ## Opting in to previews or feedback If your organization has a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan and you enable "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}", two additional options are displayed: diff --git a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md index 0a11328bb952..ddf2b4549795 100644 --- a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md +++ b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md @@ -60,8 +60,7 @@ You can create your own custom instructions file from scratch. See [Writing your You can also reach this page by clicking the **{% octicon "copilot" aria-label="Copilot icon" %}** button next to the search bar on any page on {% data variables.product.github %}, then selecting **Agents** from the sidebar. 1. Using the dropdown menu in the prompt field, select the repository you want {% data variables.product.prodname_copilot_short %} to generate custom instructions for. - -1. Copy the following prompt, customizing it if needed: +1. Copy the following prompt and paste it into the prompt field, customizing it if needed: ```markdown copy Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently. @@ -138,7 +137,7 @@ You can create your own custom instructions file from scratch. See [Writing your - Document any errors encountered as well as the steps taken to work-around them. -1. Click **Send now** or press Return. +1. Click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. {% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the list below the prompt box. {% data variables.product.prodname_copilot_short %} will create a draft pull request, write your custom instructions, push them to the branch, then add you as a reviewer when it has finished, triggering a notification. diff --git a/content/copilot/how-tos/manage-your-account/manage-policies.md b/content/copilot/how-tos/manage-your-account/manage-policies.md index a32ee86c6024..18ab4daea8ba 100644 --- a/content/copilot/how-tos/manage-your-account/manage-policies.md +++ b/content/copilot/how-tos/manage-your-account/manage-policies.md @@ -53,22 +53,29 @@ If you choose to allow suggestions matching public code, when {% data variables. {% ifversion fpt %} -## Enabling or disabling prompt and suggestion collection +## Enabling or disabling third-party coding agents in your repositories -You can choose whether your prompts and {% data variables.product.prodname_copilot_short %}'s suggestions are collected and retained by {% data variables.product.prodname_dotcom %}, and further processed and shared with Microsoft. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your settings, see [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) and the [{% data variables.product.prodname_copilot %} privacy FAQ](https://github.com/features/copilot/#faq). +> [!NOTE] +> {% data reusables.gated-features.third-party-agents %} -{% data reusables.user-settings.copilot-settings %} -1. To allow or prevent {% data variables.product.prodname_dotcom %} using your data, select or deselect **Allow {% data variables.product.prodname_dotcom %} to use my code snippets from the code editor for product improvements**. +You can choose whether to allow the following coding agents to be enabled in your personal account: + +* {% data variables.product.prodname_anthropic_claude %} +* {% data variables.product.prodname_openai_codex %} -## Enabling or disabling alternative AI models +Coding agents have access to the same repositories that {% data variables.copilot.copilot_coding_agent %} has been enabled in. -You can choose whether to allow the following AI models to be used as an alternative to {% data variables.product.prodname_copilot_short %}'s default model. +To enable coding agents: -* {% data variables.copilot.copilot_claude %} - see [AUTOTITLE](/copilot/using-github-copilot/ai-models/using-claude-in-github-copilot) -* {% data variables.copilot.copilot_gemini %} - see [AUTOTITLE](/copilot/using-github-copilot/ai-models/using-gemini-in-github-copilot) +1. Navigate to your account's [coding agent settings](https://github.com/settings/copilot/coding_agent?ref_product=copilot&ref_type=engagement&ref_style=text&utm_source=docs-3p-agents-cca-settings-cta&utm_medium=docs&utm_campaign=agent-3p-platform-feb-2026). +1. On the {% data variables.copilot.copilot_coding_agent %} page, under "Partner agents", click the toggle to enable the third-party agent you want to use. + +## Enabling or disabling prompt and suggestion collection + +You can choose whether your prompts and {% data variables.product.prodname_copilot_short %}'s suggestions are collected and retained by {% data variables.product.prodname_dotcom %}, and further processed and shared with Microsoft. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your settings, see [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) and the [{% data variables.product.prodname_copilot %} privacy FAQ](https://github.com/features/copilot/#faq). {% data reusables.user-settings.copilot-settings %} -1. To the right of the model name, select the dropdown menu, then click **Enabled** or **Disabled**. +1. To allow or prevent {% data variables.product.prodname_dotcom %} using your data, select or deselect **Allow {% data variables.product.prodname_dotcom %} to use my code snippets from the code editor for product improvements**. ## Enabling or disabling web search for {% data variables.copilot.copilot_chat %} diff --git a/content/copilot/how-tos/use-ai-models/configure-access-to-ai-models.md b/content/copilot/how-tos/use-ai-models/configure-access-to-ai-models.md index bfbfb71b8ee9..fc730ee95320 100644 --- a/content/copilot/how-tos/use-ai-models/configure-access-to-ai-models.md +++ b/content/copilot/how-tos/use-ai-models/configure-access-to-ai-models.md @@ -28,15 +28,7 @@ To learn how {% data variables.copilot.copilot_chat_short %} serves different AI ## Setup for individual use -If you have a {% data variables.copilot.copilot_free_short %}, {% data variables.copilot.copilot_pro_short %}, or {% data variables.copilot.copilot_pro_plus_short %} plan, you may need to enable access to certain models before using them. - -You can enable access in two ways: - -* The first time you use a model with {% data variables.copilot.copilot_chat_short %} in your editor or in {% data variables.product.github %}, you will be prompted to allow access to the model. - - Click **Allow** to enable the AI model and update the policy in your personal settings on {% data variables.product.github %}. - -* You can enable the model directly in your personal settings on the {% data variables.product.github %} website. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-alternative-ai-models). +If you have a {% data variables.copilot.copilot_free_short %}, {% data variables.copilot.copilot_pro_short %}, or {% data variables.copilot.copilot_pro_plus_short %} plan, you can use AI models directly within {% data variables.product.prodname_copilot_short %} without configuring access or managing policies. >[!NOTE] > * Some models may not be available depending on your plan. See [AUTOTITLE](/copilot/about-github-copilot/plans-for-github-copilot#models). diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr.md index a50aac5c0eb2..9e7af18303fb 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr.md +++ b/content/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr.md @@ -23,7 +23,7 @@ redirect_from: - /copilot/how-tos/agents/coding-agent/assign-copilot-to-an-issue - /copilot/how-tos/use-copilot-agents/coding-agent/assign-copilot-to-an-issue contentType: how-tos -category: +category: - Author and optimize with Copilot --- @@ -519,7 +519,7 @@ You can ask {% data variables.product.prodname_copilot_short %} to open a pull r 1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s pull request. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch, then push the changes to a pull request targeting that branch. {% data reusables.copilot.optional-select-custom-agent %} -1. Click {% octicon "paper-airplane" aria-label="Start task" %} **Start task** or press Return. +1. Click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. {% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the list below the prompt box. {% data variables.product.prodname_copilot_short %} will work on the task and push changes to its pull request, then add you as a reviewer when it has finished, triggering a notification. diff --git a/content/copilot/how-tos/use-copilot-agents/manage-agents.md b/content/copilot/how-tos/use-copilot-agents/manage-agents.md index 856121c52ea8..0ae7c0ddbe05 100644 --- a/content/copilot/how-tos/use-copilot-agents/manage-agents.md +++ b/content/copilot/how-tos/use-copilot-agents/manage-agents.md @@ -1,7 +1,7 @@ --- -title: Managing Copilot coding agents +title: Managing coding agents shortTitle: Manage agents -intro: View your agent's progress and keep {% data variables.product.prodname_copilot_short %} on task. +intro: View your agent's progress and keep it on task. product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot @@ -22,7 +22,7 @@ category: * Open the [Agents page](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text) * Use the **Task** button or `/task` command from [{% data variables.copilot.copilot_chat_short %}](https://github.com/copilot?ref_product=copilot&ref_type=engagement&ref_style=text) * Open the Agents panel by clicking the {% octicon "agent" aria-label="The Agents icon" %} at the top of any page on {% data variables.product.github %} -1. Using the dropdown menu, select the repository you want {% data variables.product.prodname_copilot_short %} to work in if needed. +1. Using the dropdown menu, select the repository you want the coding agent to work in. 1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s pull request. {% data reusables.copilot.optional-select-custom-agent %} 1. Optionally, select the **CURRENT-MODEL** {% octicon "chevron-down" aria-hidden="true" aria-label="chevron-down" %} dropdown menu, then click the AI model of your choice. @@ -32,7 +32,7 @@ category: Implement a user-friendly message for common errors. ``` -1. Click {% octicon "paper-airplane" aria-label="Start task" %} **Start task** or press Return. +1. Click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. {% data variables.product.prodname_copilot_short %} will start work on the task and begin pushing changes to a new pull request, where it will automatically add you as a reviewer. @@ -40,16 +40,18 @@ For more information on ways to start new agent tasks, see [AUTOTITLE](/copilot/ ## 2. Monitor agent activity -Once {% data variables.product.prodname_copilot_short %} starts working, it will continue to update the session log with its progress and thought process. +Once the agent starts working, it will continue to update the session log and overview with its progress and thought process. Each session displays its status. Click on a session to open the session log, where you can monitor the agent's progress, see the tools it's using, and track how long the session has been running. -Agent sessions can also be tracked from the {% data variables.product.prodname_cli %}, {% data variables.product.prodname_mobile %}, {% data variables.product.prodname_vscode %}, Raycast, and JetBrains IDEs. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions). +{% data variables.copilot.copilot_coding_agent %} sessions can also be tracked from the {% data variables.product.prodname_cli %}, {% data variables.product.prodname_mobile %}, {% data variables.product.prodname_vscode %}, Raycast, and JetBrains IDEs. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions). ## 3. Redirect agents as needed You can step in and provide **steering input** to {% data variables.product.prodname_copilot_short %} without stopping the run. Steering uses **one premium request** per message. +> [!NOTE] Steering a session is currently not available for **third-party coding agents**. + Reasons you might want to steer a session include: * {% data variables.product.prodname_copilot_short %} appears to be going in a wrong direction, and you want to give it more clarity. @@ -65,7 +67,7 @@ In the prompt box under the agent session log, prompt {% data variables.product. ## 4. Open an agent session in your local development environment -You can guide {% data variables.product.prodname_copilot_short %} in your local development environment on further changes, or make any edits that require human expertise. +You can guide the agent in your local development environment on further changes, or make any edits that require human expertise. ### {% data variables.product.prodname_vscode_shortname %} @@ -81,7 +83,7 @@ At the bottom of the agent session view, click the **{% octicon "vscode" aria-la ## 5. Review and merge agent code -Once {% data variables.product.prodname_copilot_short %} completes a session, you can navigate to the pull request to review the changes. From the pull request, you can scan the diff, request further improvements from {% data variables.product.prodname_copilot_short %}, or approve and merge the changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs). +Once the agent completes a session, you can navigate to the pull request to review the changes. From the pull request, you can scan the diff, request further improvements, or approve and merge the changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs). ## 6. Archive agent sessions diff --git a/content/copilot/tutorials/coding-agent/improve-a-project.md b/content/copilot/tutorials/coding-agent/improve-a-project.md new file mode 100644 index 000000000000..d29e67182b19 --- /dev/null +++ b/content/copilot/tutorials/coding-agent/improve-a-project.md @@ -0,0 +1,201 @@ +--- +title: Using GitHub Copilot coding agent to improve a project +shortTitle: Improve a project +allowTitleToDifferFromFilename: true +intro: 'Find and fix problems in a project with {% data variables.copilot.copilot_coding_agent %}.' +product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +topics: + - Copilot +contentType: tutorials +category: + - Author and optimize with Copilot + - Improve quality and maintainability + - Burn down tech debt +--- + +> [!NOTE] +> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). + +## Introduction + +Modern development often starts with good intentions: a quick script, a prototype, maybe an action to automate one small thing. But as projects evolve, those early efforts can become brittle. + +This tutorial shows how you can use {% data variables.copilot.copilot_coding_agent %} to improve a mature project, without slowing down your momentum. + +In the following sections we'll: + +* Make sure that the project contains custom instructions that {% data variables.product.prodname_copilot_short %} can use to tailor its responses to your project. +* Make sure there's an environment setup file for {% data variables.copilot.copilot_coding_agent %}, so that it can get started on tasks more quickly by pre-installing your project’s dependencies. +* Get {% data variables.product.prodname_copilot_short %} to look for improvements that could be made to the code, and then create issues for that work. +* Delegate the coding work to {% data variables.product.prodname_copilot_short %} by assigning it to an issue. + +## 1. Check for custom instructions + +1. Go to your repository on {% data variables.product.github %}. +1. Check that at least one of the following custom instructions files exists: + + * `.github/copilot-instructions.md` + * `.github/instructions/**/*-instructions.md` + * `AGENTS.md` + +1. If any of these files exists, view the file and check that the instructions are adequate and up to date. + + For more information, see the section "Writing effective custom instructions" in [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#writing-effective-custom-instructions), and the library of examples at [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions). + +1. If there are no custom instructions files in the repository, use {% data variables.copilot.copilot_coding_agent %} to create a `.github/copilot-instructions.md` file, by following the instructions in [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions#asking-copilot-coding-agent-to-generate-a-copilot-instructionsmd-file). +1. Review the pull request that {% data variables.copilot.copilot_coding_agent %} creates. Check that the `.github/copilot-instructions.md` file provides {% data variables.product.prodname_copilot_short %} with all of the information it needs to know to work on this project. + + The file should include: + + * A clear summary of the codebase and what the software does. + * A project structure overview. + * Contribution guidelines. For example, how to build, format, lint, and test the codebase, and requirements that must be met before pull requests can be merged. + * Key technical principles. + +1. Edit the file as required. +1. Click **Ready for review** at the bottom of the "Conversation" tab of the pull request, then complete your usual process for merging a pull request. + +## 2. Check for an environment setup file + +A `copilot-setup-steps.yml` {% data variables.product.prodname_actions %} workflow file can help {% data variables.copilot.copilot_coding_agent %} to get started on tasks more quickly by pre-installing the dependencies that are used by the project. + +Creating this file is optional but is a good idea if you use {% data variables.copilot.copilot_coding_agent %} regularly in the repository. + +1. In your repository on {% data variables.product.github %}, check that the following file exists: + + ```text copy + .github/workflows/copilot-setup-steps.yml + ``` + + > [!TIP] + > A quick way to do this is to copy the above path, go to the main page of your repository and paste the path into the "Go to file" field. + +1. If the file exists, open it and check that the steps in the workflow install the correct dependencies for your project. After verifying this, you can skip the remaining steps in this section. +1. If you don't already have a `copilot-setup-steps.yml` file, use the following steps to get {% data variables.copilot.copilot_coding_agent %} to create it for you. +1. At the top of any page of your repository on the {% data variables.product.github %} website, click **{% octicon "agent" aria-label="Open agents panel" %}**. +1. Copy and paste the following prompt into the Agents dialog: + + + ```text copy + Analyze this repository to understand the dependencies that need to be installed on the development environment to work on the code in this repository. Using this information, and the details about the `copilot-setup-steps.yml` file that are given in https://docs.github.com/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment, add a `.github/workflows/copilot-setup-steps.yml` to this repository. This Actions workflow file should install, in the development environment for {% data variables.copilot.copilot_coding_agent %}, all of the dependencies necessary to work on the code in this repository. Make sure that the workflow job is named `copilot-setup-steps`. + ``` + + +1. Click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. +1. In the "Recent agent sessions" list, click the new agent session that has started. + + This displays an activity log, as {% data variables.product.prodname_copilot_short %} works on the task. When {% data variables.product.prodname_copilot_short %} finishes it will generate a summary of what it did. + +1. Read the summary, then click **{% octicon "git-pull-request" aria-hidden="true" aria-label="Pull request" %} View pull request**. +1. Optionally, add {% data variables.product.prodname_copilot_short %} as a reviewer. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review?tool=webui). Wait for {% data variables.product.prodname_copilot_short %} to add review comments, then make any changes you think are necessary in response to the comments. +1. Review the pull request yourself, making sure that the setup steps in the new `copilot-setup-steps.yml` file are correct. + + The workflow file that {% data variables.product.prodname_copilot_short %} has created should include an `on: workflow_dispatch` trigger, to allow you to run the workflow manually, and the job must be named `copilot-setup-steps` as shown in this extract: + + ```yaml + on: + workflow_dispatch: + push: + paths: + - .github/workflows/copilot-setup-steps.yml + pull_request: + paths: + - .github/workflows/copilot-setup-steps.yml + + jobs: + copilot-setup-steps: + runs-on: ubuntu-latest + ``` + +1. Make any required changes to the `copilot-setup-steps.yml` file in the pull request. + + You can ask {% data variables.product.prodname_copilot_short %} to make changes for you by using `@copilot` in a review comment. For example: + + `@copilot - comment the file more thoroughly` + +1. Click **Ready for review** at the bottom of the "Conversation" tab of the pull request, then complete your usual process for merging a pull request. +1. Open the newly added `.github/workflows/copilot-setup-steps.yml` file in your repository on {% data variables.product.github %}. +1. Click **View Runs** near the top right of the page. +1. Click **Run workflow** and then **Run workflow** in the dialog, to test the new workflow. +1. Check that the workflow runs correctly and installs the dependencies. Fix any failures by editing the `.github/workflows/copilot-setup-steps.yml` file. + +## 3. Let {% data variables.product.prodname_copilot_short %} find technical debt + +Now that {% data variables.product.prodname_copilot_short %} has the right context and (optionally) a ready-to-use environment, you can use it to surface and prioritize technical debt in your repository. +1. Click the **{% octicon "copilot" aria-label="Run this prompt in Copilot Chat" %}** button in the following prompt box to send this prompt to {% data variables.copilot.copilot_chat_short %} on {% data variables.product.prodname_dotcom_the_website %}. + + ```copilot copy prompt + What technical debt exists in this project? Give me a prioritized list of up to 5 areas we need to focus on. For each, describe the problem and its consequences. + ``` + +1. Make sure that **{% octicon "comment" aria-hidden="true" aria-label="comment" %} Ask** mode is selected. +1. Use the **{% octicon "globe" aria-hidden="true" aria-label="globe" %} All repositories** dropdown to select your repository. +1. Click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. +1. Review the details in {% data variables.product.prodname_copilot_short %}'s response. +1. Assuming {% data variables.product.prodname_copilot_short %} identified at least one area for improvement, copy the following prompt into the same conversation: + + ```copilot copy + /create-issue + + Create a GitHub issue to address the first of the problem areas that you identified. + + If the problem area requires substantial work, create one main issue for the entire problem area and then sub-issues that allow the work to be split up into manageable chunks, which will be tackled in separate pull requests that can be easily reviewed. For a large body of work, do not create a single issue that attempts to address the entire problem. + + The issue, or each sub-issue if these are created, must include a description of the problem, a set of acceptance criteria, and pointers on what files need to be added/updated. + ``` + +1. Edit this prompt as required. For example, depending on the response that {% data variables.product.prodname_copilot_short %} produced, you may want to work on another of the problem areas that {% data variables.product.prodname_copilot_short %} identified, rather than the first. +1. Make sure that Ask mode is still selected (**{% octicon "comment" aria-label="comment icon" %}**). +1. Click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. +1. Review the draft issue that {% data variables.product.prodname_copilot_short %} generates, editing it as required. +1. If {% data variables.product.prodname_copilot_short %} creates a single draft issue that indicates that sub-issues should be created, prompt {% data variables.product.prodname_copilot_short %} to do this for you: + + ```copilot copy + Go ahead and create sub-issues that chunk this work into manageable pieces. + ``` + +1. Click **Create**, or **Review and Create**, depending on how many issues were drafted. + + {% data variables.product.prodname_copilot_short %} creates one or more new issues on your behalf. You will be shown as the issue author. + +## 4. Get {% data variables.product.prodname_copilot_short %} to fix an issue + +Now that you have created issues, the next step is to delegate an issue to {% data variables.product.prodname_copilot_short %} and review the resulting pull request. +1. Open one of the issues that {% data variables.product.prodname_copilot_short %} created for you in the previous section. +1. Check that the issue contains acceptance criteria that {% data variables.product.prodname_copilot_short %} can use to verify it has completed the task. +1. Make any changes you feel are necessary to accurately describe the problem that needs to be fixed, and the expected outcome of the work on this issue. +1. Click **{% octicon "agent" aria-label="Open agents panel" %} Assign to {% data variables.product.prodname_copilot_short %}**. +1. In the "Assign Copilot to issue", click **Assign**. + + {% data variables.product.prodname_copilot_short %} will start working on the issue. After a few moments a link to a draft pull request will be added to the issue. + +1. Click the link to the draft pull request. + + Once {% data variables.product.prodname_copilot_short %} has finished working on the pull request it will remove "[WIP]" from the pull request title and will add you as a reviewer. + + You can leave {% data variables.product.prodname_copilot_short %} to work on the pull request asynchronously, and come back to review the pull request once you are added as a reviewer. + +1. Optionally, after {% data variables.product.prodname_copilot_short %} has been working for a couple of minutes, you can click **View session** on the pull request to see a log of what {% data variables.product.prodname_copilot_short %} is doing. +1. Optionally, on the "Conversation" tab of the pull request, add {% data variables.product.prodname_copilot_short %} as a reviewer. +1. After you have been added as a reviewer, review the changes yourself and make any required changes. + + You can ask {% data variables.product.prodname_copilot_short %} to make changes for you by using `@copilot` in a review comment. + +1. Click **Ready for review** at the bottom of the "Conversation" tab of the pull request, then complete your usual process for merging a pull request. + +## 5. Iterate on this process + +1. If {% data variables.product.prodname_copilot_short %} created multiple issues, repeat section 4, assigning {% data variables.product.prodname_copilot_short %} to one of the other issues. +1. After closing all of the issues that {% data variables.product.prodname_copilot_short %} created, repeat section 3, choosing another problem area and iterating on section 4 to assign issues to {% data variables.product.prodname_copilot_short %} and review and merge its changes. + +## Conclusion + +{% data variables.copilot.copilot_coding_agent %} can help you to improve the quality of code in any project, but it's particularly useful for reducing technical debt in a project that has grown organically over many months or years. By using {% data variables.copilot.copilot_coding_agent %}, you can make improvements that you might have struggled to find time for without an AI assistant working on your behalf. + +{% data variables.product.prodname_copilot_short %} doesn't replace you as a developer—you still need to be involved at every step of this process, specifying what you want {% data variables.product.prodname_copilot_short %} to do and carefully reviewing the code it changes or adds—but it does allow you to implement improvements at the same time as you work on other important tasks. + +## Next steps + +Read this case study on the {% data variables.product.github %} blog: [How the {% data variables.product.github %} billing team uses the coding agent in {% data variables.product.prodname_copilot %} to continuously burn down technical debt](https://github.blog/ai-and-ml/github-copilot/how-the-github-billing-team-uses-the-coding-agent-in-github-copilot-to-continuously-burn-down-technical-debt/). diff --git a/content/copilot/tutorials/coding-agent/index.md b/content/copilot/tutorials/coding-agent/index.md index 0c4fd6c110f0..49e61e299a66 100644 --- a/content/copilot/tutorials/coding-agent/index.md +++ b/content/copilot/tutorials/coding-agent/index.md @@ -10,5 +10,6 @@ topics: children: - /get-the-best-results - /pilot-coding-agent + - /improve-a-project contentType: tutorials --- diff --git a/content/copilot/tutorials/customization-library/custom-agents/bug-fix-teammate.md b/content/copilot/tutorials/customization-library/custom-agents/bug-fix-teammate.md index e9cce4104082..1d2975b39c9b 100644 --- a/content/copilot/tutorials/customization-library/custom-agents/bug-fix-teammate.md +++ b/content/copilot/tutorials/customization-library/custom-agents/bug-fix-teammate.md @@ -68,7 +68,7 @@ Your goal is to make the codebase more stable and reliable by implementing worki 1. Click {% octicon "copilot" aria-hidden="true" aria-label="copilot" %}, then click **{% octicon "plus" aria-label="Plus button" %} Create a custom agent**. 1. An {% data variables.copilot.agent_profile %} template called `my-agent.agent.md` will open in the `.github/agents` directory, in the repository you chose. Name the file `bug-fix-teammate.agent.md` and paste in the example {% data variables.copilot.agent_profile %}. 1. Commit and merge this file into your repository's default branch. Go back to the agents tab (you may need to refresh the page), and in the text box, select your "bug-fix-teammate" agent from the dropdown. -1. In the text box, enter a task for the agent (such as the example below) and click **{% octicon "paper-airplane" aria-label="Start task" %} Start task** or press Return. +1. In the text box, enter a task for the agent (such as the example below) and click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. ```copilot copy Scan the repository for the most critical bug, then implement a targeted fix and explain your approach. diff --git a/content/copilot/tutorials/customization-library/custom-agents/cleanup-specialist.md b/content/copilot/tutorials/customization-library/custom-agents/cleanup-specialist.md index 63f72ff5effd..6ae1faef262d 100644 --- a/content/copilot/tutorials/customization-library/custom-agents/cleanup-specialist.md +++ b/content/copilot/tutorials/customization-library/custom-agents/cleanup-specialist.md @@ -78,7 +78,7 @@ Focus on cleaning up existing code rather than adding new features. Work on both 1. Click {% octicon "copilot" aria-hidden="true" aria-label="copilot" %}, then click **{% octicon "plus" aria-label="Plus button" %} Create a custom agent**. 1. An {% data variables.copilot.agent_profile %} template called `my-agent.agent.md` will open in the `.github/agents` directory, in the repository you chose. Name the file `cleanup-specialist.agent.md` and paste in the example {% data variables.copilot.agent_profile %}. 1. Commit and merge this file into your repository's default branch. Go back to the agents tab (you may need to refresh the page), and in the text box, select your "cleanup-specialist" agent from the dropdown. -1. In the text box, enter a task for the agent (such as the example below) and click **{% octicon "paper-airplane" aria-label="Start task" %} Start task** or press Return. +1. In the text box, enter a task for the agent (such as the example below) and click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. ```copilot copy Refactor and clean up any messy or inconsistent code in the `src/utils` directory, then document the improvements you made. diff --git a/content/copilot/tutorials/customization-library/custom-agents/implementation-planner.md b/content/copilot/tutorials/customization-library/custom-agents/implementation-planner.md index d5d8a3f10866..e147a347e50e 100644 --- a/content/copilot/tutorials/customization-library/custom-agents/implementation-planner.md +++ b/content/copilot/tutorials/customization-library/custom-agents/implementation-planner.md @@ -41,7 +41,7 @@ When creating implementation plans, use this structure (adapt sections based on - Success criteria (what does "done" look like?) - Who will use this and how? -## Technical Approach +## Technical Approach - High-level architecture and key technology choices - Important APIs, data structures, or integrations - Major technical decisions and trade-offs @@ -82,7 +82,7 @@ Adjust the detail level based on your needs - solo projects might need less form 1. Click {% octicon "copilot" aria-hidden="true" aria-label="copilot" %}, then click **{% octicon "plus" aria-label="Plus button" %} Create a custom agent**. 1. An {% data variables.copilot.agent_profile %} template called `my-agent.agent.md` will open in the `.github/agents` directory, in the repository you chose. Name the file `implementation-planner.agent.md` and paste in the example {% data variables.copilot.agent_profile %}. 1. Commit and merge this file into your repository's default branch. Go back to the agents tab (you may need to refresh the page), and in the text box, select your "implementation-planner" agent from the dropdown. -1. In the text box, enter a task for the agent (such as the example below) and click **{% octicon "paper-airplane" aria-label="Start task" %} Start task** or press Return. +1. In the text box, enter a task for the agent (such as the example below) and click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. ```copilot copy Create a detailed implementation plan for adding user authentication to our web app, including technical approach, phases, and risk assessment. diff --git a/content/copilot/tutorials/customization-library/custom-agents/your-first-custom-agent.md b/content/copilot/tutorials/customization-library/custom-agents/your-first-custom-agent.md index f745fce663ad..ad901c5e8648 100644 --- a/content/copilot/tutorials/customization-library/custom-agents/your-first-custom-agent.md +++ b/content/copilot/tutorials/customization-library/custom-agents/your-first-custom-agent.md @@ -77,7 +77,7 @@ Test this agent by giving it a task to complete: 1. Click {% octicon "copilot" aria-hidden="true" aria-label="copilot" %}, then click **{% octicon "plus" aria-label="Plus button" %} Create a custom agent**. 1. An {% data variables.copilot.agent_profile %} template called `my-agent.agent.md` will open in the `.github/agents` directory, in the repository you chose. Name the file `readme-specialist.agent.md` and paste in the example {% data variables.copilot.agent_profile %}. 1. Commit and merge this file into your repository's default branch. Go back to the agents tab (you may need to refresh the page), and in the text box, select your "readme-specialist" agent from the dropdown. -1. In the text box, enter a task for the agent (such as the example below) and click **{% octicon "paper-airplane" aria-label="Start task" %} Start task** or press Return. +1. In the text box, enter a task for the agent (such as the example below) and click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. ```copilot copy Please review and improve our README.md file. diff --git a/content/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization.md b/content/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization.md index c24c2df5fa8f..4d9e9019ffdd 100644 --- a/content/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization.md @@ -13,7 +13,7 @@ shortTitle: Repository custom properties ## About custom properties -{% data reusables.enterprise.custom-properties-intro %} See [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/custom-properties). +{% data reusables.enterprise.custom-properties-intro %}{% ifversion ghec or ghes > 3.20 %} See [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/custom-properties).{% endif %} This article relates to **repository custom properties.** diff --git a/data/reusables/copilot/coding-agent/new-agent-task-form-instructions.md b/data/reusables/copilot/coding-agent/new-agent-task-form-instructions.md index 3283372f57e0..2e38bcc185aa 100644 --- a/data/reusables/copilot/coding-agent/new-agent-task-form-instructions.md +++ b/data/reusables/copilot/coding-agent/new-agent-task-form-instructions.md @@ -6,6 +6,6 @@ 1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s pull request. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch, then push the changes to a pull request targeting that branch. 1. {% data reusables.copilot.optional-select-custom-agent %} {% data reusables.copilot.optional-select-copilot-coding-agent-model %} -1. Click **{% octicon "paper-airplane" aria-label="Start task" %} Start task** or press Return. +1. Click **{% octicon "paper-airplane" aria-label="Start task" %}** or press Enter. {% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the list below the prompt box. {% data variables.product.prodname_copilot_short %} will work on the task and push changes to its pull request, then add you as a reviewer when it has finished, triggering a notification. diff --git a/data/reusables/copilot/differences-cfi-cfb-table.md b/data/reusables/copilot/differences-cfi-cfb-table.md index dba95f7a3c94..94c0934fc205 100644 --- a/data/reusables/copilot/differences-cfi-cfb-table.md +++ b/data/reusables/copilot/differences-cfi-cfb-table.md @@ -18,6 +18,7 @@ | Agent mode | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | {% data variables.product.prodname_copilot_short %} code review | Only "Review selection" in {% data variables.product.prodname_vscode_shortname %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | Model Context Protocol (MCP) | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| Third-party Agents ({% data variables.release-phases.public_preview %}) | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% endrowheaders %} diff --git a/data/reusables/copilot/optional-select-custom-agent.md b/data/reusables/copilot/optional-select-custom-agent.md index 1cc5352fccf4..80ba04956203 100644 --- a/data/reusables/copilot/optional-select-custom-agent.md +++ b/data/reusables/copilot/optional-select-custom-agent.md @@ -1 +1,2 @@ -1. Optionally, you can click {% octicon "copilot" aria-hidden="true" aria-label="copilot" %} to open the "Custom agent" dropdown menu, if you want to assign a {% data variables.copilot.copilot_custom_agent_short %} with specialized behavior and tools. You can select an existing {% data variables.copilot.copilot_custom_agent_short %} from your repository, organization, or enterprise. You can also click **{% octicon "plus" aria-label="Plus button" %} Create an agent** to create a new {% data variables.copilot.agent_profile %} in your selected repository and branch. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). +1. Optionally, you can click {% octicon "copilot" aria-hidden="true" aria-label="copilot" %} to open the agent dropdown menu, if you want to assign a coding agent or a {% data variables.copilot.copilot_custom_agent_short %} with specialized behavior and tools. You can select an existing {% data variables.copilot.copilot_custom_agent_short %} from your repository, organization, or enterprise. You can also click **{% octicon "plus" aria-label="Plus button" %} Create an agent** to create a new {% data variables.copilot.agent_profile %} in your selected repository and branch. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). + > [!NOTE] Third-party coding agents are available in the {% data variables.copilot.copilot_pro_plus %} and {% data variables.copilot.copilot_enterprise_short %} plans. diff --git a/data/reusables/gated-features/anthropic-claude.md b/data/reusables/gated-features/anthropic-claude.md new file mode 100644 index 000000000000..3665f5f6e98e --- /dev/null +++ b/data/reusables/gated-features/anthropic-claude.md @@ -0,0 +1 @@ +{% data variables.product.prodname_anthropic_claude %} is only available with the {% data variables.copilot.copilot_pro_plus %} plan. diff --git a/data/reusables/gated-features/third-party-agents.md b/data/reusables/gated-features/third-party-agents.md new file mode 100644 index 000000000000..d93ce1814241 --- /dev/null +++ b/data/reusables/gated-features/third-party-agents.md @@ -0,0 +1 @@ +Third-party agents are available in the {% data variables.copilot.copilot_pro_plus %} and {% data variables.copilot.copilot_enterprise %} plans. \ No newline at end of file diff --git a/data/variables/product.yml b/data/variables/product.yml index d8559892ceed..56ad1cf02657 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -379,3 +379,6 @@ graphql_url: >- # OpenAI Codex prodname_openai_codex: 'OpenAI Codex' + +# Anthropic Claude +prodname_anthropic_claude: 'Anthropic Claude' diff --git a/src/data-directory/lib/data-schemas/ctas.ts b/src/data-directory/lib/data-schemas/ctas.ts index 3951ae78847b..ab7e97cac211 100644 --- a/src/data-directory/lib/data-schemas/ctas.ts +++ b/src/data-directory/lib/data-schemas/ctas.ts @@ -40,7 +40,7 @@ export default { name: 'Plan', description: 'For links to sign up for or trial a plan, the specific plan we link to (optional)', - enum: ['enterprise', 'business', 'pro', 'free'], + enum: ['enterprise', 'business', 'pro', 'pro-plus', 'free'], }, }, } diff --git a/src/fixtures/tests/playwright-rendering.spec.ts b/src/fixtures/tests/playwright-rendering.spec.ts index bcade919dee8..d844e2294dd6 100644 --- a/src/fixtures/tests/playwright-rendering.spec.ts +++ b/src/fixtures/tests/playwright-rendering.spec.ts @@ -505,11 +505,7 @@ test.describe('test nav at different viewports', () => { await page.goto('/get-started/foo/bar') // version picker should be visible - await page - .getByRole('button', { - name: 'Select GitHub product version: current version is free-pro-team@latest', - }) - .click() + await page.getByTestId('version-picker').getByRole('button').click() expect((await page.getByRole('menuitemradio').all()).length).toBeGreaterThan(0) await expect(page.getByRole('menuitemradio', { name: 'Enterprise Cloud' })).toBeVisible() @@ -549,11 +545,7 @@ test.describe('test nav at different viewports', () => { await page.goto('/get-started/foo/bar') // version picker is visible - await page - .getByRole('button', { - name: 'Select GitHub product version: current version is free-pro-team@latest', - }) - .click() + await page.getByTestId('version-picker').getByRole('button').click() expect((await page.getByRole('menuitemradio').all()).length).toBeGreaterThan(0) await expect(page.getByRole('menuitemradio', { name: 'Enterprise Cloud' })).toBeVisible() @@ -584,11 +576,7 @@ test.describe('test nav at different viewports', () => { await expect(page.getByTestId('language-picker')).not.toBeVisible() // version picker is visible - await expect( - page.getByRole('button', { - name: 'Select GitHub product version: current version is free-pro-team@latest', - }), - ).toBeVisible() + await expect(page.getByTestId('version-picker').getByRole('button')).toBeVisible() // language picker is in mobile menu await page.getByTestId('mobile-menu').click() @@ -619,11 +607,7 @@ test.describe('test nav at different viewports', () => { await expect(page.getByTestId('language-picker')).not.toBeVisible() // version picker is not visible - await expect( - page.getByRole('button', { - name: 'Select GitHub product version: current version is free-pro-team@latest', - }), - ).not.toBeVisible() + await expect(page.getByTestId('version-picker').getByRole('button')).not.toBeVisible() // version picker is in mobile menu await expect(page.getByTestId('version-picker')).not.toBeVisible() diff --git a/src/landings/components/discovery/DiscoveryLanding.tsx b/src/landings/components/discovery/DiscoveryLanding.tsx index 7c764bc0f678..fe18a1e88c88 100644 --- a/src/landings/components/discovery/DiscoveryLanding.tsx +++ b/src/landings/components/discovery/DiscoveryLanding.tsx @@ -25,7 +25,7 @@ export const DiscoveryLanding = () => { return ( -
+
{/* Render carousels */} diff --git a/src/landings/components/journey/JourneyLanding.tsx b/src/landings/components/journey/JourneyLanding.tsx index 6535620ae981..b234608792f7 100644 --- a/src/landings/components/journey/JourneyLanding.tsx +++ b/src/landings/components/journey/JourneyLanding.tsx @@ -10,7 +10,7 @@ export const JourneyLanding = () => { return ( -
+
diff --git a/src/tools/components/Picker.tsx b/src/tools/components/Picker.tsx index 679e91b954fe..e125576795f6 100644 --- a/src/tools/components/Picker.tsx +++ b/src/tools/components/Picker.tsx @@ -13,7 +13,7 @@ interface Props { pickerLabel?: string dataTestId: string defaultText: string - ariaLabel: string + ariaLabel?: string alignment: AnchorAlignment descriptionFontSize?: number renderItem?: (item: PickerItem) => ReactNode | string diff --git a/src/versions/components/VersionPicker.tsx b/src/versions/components/VersionPicker.tsx index 921b1dde45f9..49fcb22c9d15 100644 --- a/src/versions/components/VersionPicker.tsx +++ b/src/versions/components/VersionPicker.tsx @@ -95,7 +95,6 @@ export const VersionPicker = ({ xs }: Props) => { pickerLabel={xs ? `Version\n` : `Version: `} dataTestId="field" descriptionFontSize={xs ? 6 : 5} - ariaLabel={`Select GitHub product version: current version is ${currentVersion}`} renderItem={(item) => { return (