Add content for the limited public beta of Copilot Extensibility (#50525)
Co-authored-by: hubwriter <hubwriter@github.com>
This commit is contained in:
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: About GitHub Copilot Extensions
|
||||
intro: '{% data variables.product.prodname_copilot_extensions %} are integrations for external tools in {% data variables.product.prodname_copilot_chat %}.'
|
||||
product: '{% data reusables.gated-features.copilot-extensions %}'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: About Copilot Extensions
|
||||
type: overview
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.copilot-extensions-intro %}
|
||||
|
||||
> [!NOTE] {% data variables.product.prodname_copilot_extensions %} are not the same as the {% data variables.product.prodname_copilot %} extension, which you install in an external application to access {% data variables.product.prodname_copilot_short %} within that application. For more information on the {% data variables.product.prodname_copilot %} extension, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot)."
|
||||
|
||||
After you install a {% data variables.product.prodname_copilot_extension_short %} from {% data variables.product.prodname_marketplace %}, you can interact with that extension in a {% data variables.product.prodname_copilot_chat_short %} conversation, asking questions and authorizing actions that combine the capabilities of the external tool and {% data variables.product.prodname_dotcom %}. For example, if you install the Sentry extension for {% data variables.product.prodname_copilot %}, you can use the extension to get information about Sentry issues, then create and assign related tracking issues on {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
{% data variables.product.prodname_copilot_extensions_short %} provide several benefits, including:
|
||||
|
||||
- Interaction with external tools using natural language
|
||||
- Reduced context switching
|
||||
- Customization of your {% data variables.product.prodname_copilot_chat_short %} experience for your developer flow
|
||||
|
||||
**{% data variables.product.prodname_copilot_extensions_short %} are included in all {% data variables.product.prodname_copilot_short %} subscriptions**, and can be used with:
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.compatible-chat-interfaces %}
|
||||
|
||||
## Next steps
|
||||
|
||||
If you have a {% data variables.product.prodname_copilot_individuals_short %} subscription, to get started with {% data variables.product.prodname_copilot_extensions_short %}, see "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account)."
|
||||
|
||||
If you are an organization owner or enterprise administrator with a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, you should set a policy for {% data variables.product.prodname_copilot_extension_short %} usage in your enterprise or organization. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/managing-github-copilot-extensions)."
|
||||
|
||||
If you are a developer with {% data variables.product.prodname_copilot_short %} access through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, to get started with {% data variables.product.prodname_copilot_extensions_short %}, see "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions)."
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: GitHub Copilot Extensions
|
||||
shortTitle: Copilot Extensions
|
||||
intro: 'Learn about {% data variables.product.prodname_copilot_extensions %} (beta) and their uses.'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /about-github-copilot-extensions
|
||||
- /managing-github-copilot-extensions
|
||||
- /installing-github-copilot-extensions-for-your-personal-account
|
||||
- /installing-github-copilot-extensions-for-your-organization
|
||||
- /using-github-copilot-extensions
|
||||
---
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Installing GitHub Copilot Extensions for your organization
|
||||
intro: 'You can install {% data variables.product.prodname_copilot_extensions %} for your organization from {% data variables.product.prodname_marketplace %}.'
|
||||
product: 'Organization owners can install {% data variables.product.prodname_copilot_extensions %} for an organization.'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Install organization extensions
|
||||
type: how_to
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About installing {% data variables.product.prodname_copilot_extensions %} for your organization
|
||||
|
||||
Before you install any {% data variables.product.prodname_copilot_extensions_short %} in your organization, you should set a usage policy for {% data variables.product.prodname_copilot_extensions_short %} at the {% ifversion ghec %}enterprise or {% endif %}organization level. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/managing-github-copilot-extensions)."
|
||||
|
||||
Any organization owner can install {% data variables.product.prodname_copilot_extensions_short %} for their organization, but your organization must meet the following criteria to use an installed {% data variables.product.prodname_copilot_extension_short %}:
|
||||
|
||||
- Your organization is enrolled in the limited public beta for {% data variables.product.prodname_copilot_extensions_short %}.
|
||||
- Your organization has an active {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription.
|
||||
|
||||
> [!NOTE] Anyone can install a {% data variables.product.prodname_copilot_extension_short %} on their personal account. However, if they get access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, they will only be able to use the extension if it is installed at the organization level.
|
||||
|
||||
## Installing {% data variables.product.prodname_copilot_extensions %} for your organization
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.copilot-extensions-on-marketplace %}
|
||||
|
||||
To install a {% data variables.product.prodname_copilot_extension_short %} on an organization with a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations)."
|
||||
|
||||
## Next steps
|
||||
|
||||
After installing a {% data variables.product.prodname_copilot_extension_short %} for your organization, developers in your organization can start using the extension. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions)."
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Installing GitHub Copilot Extensions for your personal account
|
||||
intro: 'You can install {% data variables.product.prodname_copilot_extensions %} for your personal account from {% data variables.product.prodname_marketplace %}.'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Install personal extensions
|
||||
type: how_to
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About installing {% data variables.product.prodname_copilot_extensions %} for your personal account
|
||||
|
||||
Anyone can install {% data variables.product.prodname_copilot_extensions_short %} for their personal account, but you must meet the following criteria to use a {% data variables.product.prodname_copilot_extension_short %} you install:
|
||||
|
||||
- You are enrolled in the limited public beta for {% data variables.product.prodname_copilot_extensions_short %}.
|
||||
- You have an active {% data variables.product.prodname_copilot_individuals_short %} subscription.
|
||||
|
||||
> [!NOTE] If you have access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, {% data variables.product.prodname_copilot_extensions_short %} are installed by organization owners at the organization level, and you do not need to install the extension on your personal account. To start using {% data variables.product.prodname_copilot_extensions_short %} installed in your organization, see "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions)."
|
||||
|
||||
## Installing {% data variables.product.prodname_copilot_extensions %} for your personal account
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.copilot-extensions-on-marketplace %}
|
||||
|
||||
To install a {% data variables.product.prodname_copilot_extension_short %} on your personal account, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account#installing-a-github-app-in-your-personal-account)."
|
||||
|
||||
## Next steps
|
||||
|
||||
After installing a {% data variables.product.prodname_copilot_extension_short %}, you can start using the extension in {% data variables.product.prodname_copilot_chat_short %}. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions)."
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: Managing GitHub Copilot Extensions
|
||||
intro: 'You can manage {% data variables.product.prodname_copilot_extension %} policies and permissions in your organization{% ifversion ghec %} or enterprise{% endif %}.'
|
||||
product: 'Organization owners {% ifversion ghec %}and enterprise administrators {% endif %}can manage {% data variables.product.prodname_copilot_extensions_short %}.'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Manage Copilot Extensions
|
||||
type: how_to
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About managing {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
Before you install {% data variables.product.prodname_copilot_extensions_short %} in your organization, you should set a usage policy for your {% ifversion ghec %}enterprise or {% endif %}organization. Setting a usage policy allows you to enable or disable {% data variables.product.prodname_copilot_extensions_short %} for all members of your {% ifversion ghec %}enterprise or {% endif %}organization, limiting your security risk. See {% ifversion ghec %}"[Setting a policy for {% data variables.product.prodname_copilot_extensions %} in your enterprise](#setting-a-policy-for-github-copilot-extensions-in-your-enterprise)" and {% endif %}"[Setting a policy for {% data variables.product.prodname_copilot_extensions %} in your organization](#setting-a-policy-for-github-copilot-extensions-in-your-organization)."
|
||||
|
||||
Additionally, after you install a {% data variables.product.prodname_copilot_extension_short %} in your organization, you can view and manage the permissions for that extension. See "[Managing permissions for a {% data variables.product.prodname_copilot_extension %} in your organization](#managing-permissions-for-a-github-copilot-extension-in-your-organization)."
|
||||
|
||||
{% ifversion ghec %}
|
||||
|
||||
## Setting a policy for {% data variables.product.prodname_copilot_extensions %} in your enterprise
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.copilot-tab %}
|
||||
{% data reusables.enterprise-accounts.copilot-policies-tab %}
|
||||
1. In the "{% data variables.product.prodname_copilot_extensions_short %}" section, select the dropdown menu, then click one of the following options:
|
||||
- **No policy**: organizations within your enterprise can set their own policies for {% data variables.product.prodname_copilot_extensions_short %}.
|
||||
- **Enabled**: {% data variables.product.prodname_copilot_extensions_short %} are enabled for all organizations in your enterprise.
|
||||
- **Disabled**: {% data variables.product.prodname_copilot_extensions_short %} are disabled for all organizations in your enterprise.
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Setting a policy for {% data variables.product.prodname_copilot_extensions %} in your organization
|
||||
|
||||
{% ifversion ghec %}
|
||||
If {% data variables.product.prodname_copilot_extensions_short %} have not been enabled or disabled at the enterprise level, you can set a {% data variables.product.prodname_copilot_extensions_short %} policy for your organization.
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.copilot.policy-settings %}
|
||||
1. In the "{% data variables.product.prodname_copilot_extensions_short %}" section, select the dropdown menu, then enable or disable {% data variables.product.prodname_copilot_extensions_short %} for your organization.
|
||||
|
||||
## Managing permissions for a {% data variables.product.prodname_copilot_extension %} in your organization
|
||||
|
||||
After you have installed a {% data variables.product.prodname_copilot_extension_short %} in your organization, you can view the permissions the extension has in your organization, and why those permissions are necessary. If you do not want the {% data variables.product.prodname_copilot_extension_short %} to have the listed permissions, you can suspend or uninstall the extension.
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.apps.access-org-app-settings %}
|
||||
1. Optionally, to filter your installed {% data variables.product.prodname_github_apps %} for {% data variables.product.prodname_copilot_extensions_short %}, select the **Filter:** dropdown menu, then click **{% data variables.product.prodname_copilot_extensions_short %}**.
|
||||
1. Next to the {% data variables.product.prodname_copilot_extension_short %} you want to review or modify, click **Configure**.
|
||||
1. In the "Permissions" section, review the permissions listed for the {% data variables.product.prodname_copilot_extension_short %}. Optionally, you can block the {% data variables.product.prodname_copilot_extension_short %}'s access to your organization in one of two ways:
|
||||
- To indefinitely suspend the {% data variables.product.prodname_copilot_extension_short %}'s access to resources in your organization while keeping the extension installed, in the "Danger zone" section, click **Suspend**.
|
||||
- To uninstall a {% data variables.product.prodname_copilot_extension_short %} completely, in the "Danger zone" section, click **Uninstall**.
|
||||
|
||||
## Next steps
|
||||
|
||||
After you have set a {% data variables.product.prodname_copilot_extensions_short %} policy, you can install {% data variables.product.prodname_copilot_extensions_short %} for your organization. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization)."
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Using GitHub Copilot Extensions
|
||||
intro: 'You can use {% data variables.product.prodname_copilot_extensions %} to interact with external tools in {% data variables.product.prodname_copilot_chat %}.'
|
||||
product: '{% data reusables.gated-features.copilot-extensions %}'
|
||||
versions:
|
||||
feature: copilot-extensions
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Use Copilot Extensions
|
||||
type: how_to
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.beta-note %}
|
||||
|
||||
## About using {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
{% data variables.product.prodname_copilot_extensions_short %} **work the same way across all {% data variables.product.prodname_copilot_chat_short %} interfaces where {% data variables.product.prodname_copilot_extensions_short %} are available**. {% data variables.product.prodname_copilot_extensions_short %} are available in:
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.compatible-chat-interfaces %}
|
||||
|
||||
If you have a {% data variables.product.prodname_copilot_individuals_short %} subscription, you need to install a {% data variables.product.prodname_copilot_extension_short %} before you can use the extension in {% data variables.product.prodname_copilot_chat_short %}. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account)."
|
||||
|
||||
If you have access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, an organization owner needs to install {% data variables.product.prodname_copilot_extensions_short %} for your organization. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization)."
|
||||
|
||||
## Using {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
1. To start using a {% data variables.product.prodname_copilot_extension_short %}, open any of the following {% data variables.product.prodname_copilot_chat_short %} interfaces:
|
||||
- {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=vscode#asking-your-first-question)."
|
||||
- {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=visualstudio#asking-your-first-question-1)."{% ifversion ghec %}
|
||||
- {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %} (if you have a {% data variables.product.prodname_copilot_enterprise_short %} subscription). See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom#asking-a-general-question-about-software-development)."{% endif %}
|
||||
1. To see a list of all {% data variables.product.prodname_copilot_extensions_short %} available in your {% data variables.product.prodname_copilot_chat_short %} conversation, in the {% data variables.product.prodname_copilot_chat_short %} text box, type `@`.
|
||||
|
||||
> [!NOTE] If you are using {% data variables.product.prodname_copilot_chat_short %} in an IDE, and you or your organization owner install a {% data variables.product.prodname_copilot_extension_short %} while your IDE is open, you need to restart your IDE to begin using the {% data variables.product.prodname_copilot_extension_short %}.
|
||||
|
||||
1. In the list of available {% data variables.product.prodname_copilot_extensions_short %}, click the one you want to use.
|
||||
1. To begin interacting with the {% data variables.product.prodname_copilot_extension_short %}, in the {% data variables.product.prodname_copilot_chat_short %} text box, ask the extension to answer a question or perform an action, then press <kbd>Enter</kbd>. For each new request, be sure to include `@EXTENSION-NAME` at the beginning of your sentence.
|
||||
- If you did not install the {% data variables.product.prodname_copilot_extension_short %} yourself, and it is your first time using the {% data variables.product.prodname_copilot_extension_short %}, you will be asked to authorize the extension. See "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)."
|
||||
- If you ask a {% data variables.product.prodname_copilot_extension_short %} to perform an action, you need to confirm the extension has your permission to act on your behalf before it will complete the task. After carefully reviewing the proposed action, in the confirmation dialog, click **Allow** or **Dismiss**.
|
||||
|
||||
## Tips for using {% data variables.product.prodname_copilot_extensions %}
|
||||
|
||||
- When you are using a {% data variables.product.prodname_copilot_extension_short %}, consider how you would interact with the tool outside of {% data variables.product.prodname_copilot_chat_short %}, then use natural language to ask questions and assign tasks that integrate the capabilities of the tool with {% data variables.product.prodname_dotcom %}. For example, [Sentry](https://sentry.io/welcome/) is an application monitoring software with a {% data variables.product.prodname_copilot_extension_short %}. The following are some example prompts for the Sentry extension for {% data variables.product.prodname_copilot %}:
|
||||
- `@sentry list my most recent issues`
|
||||
- `@sentry tell me more about issue ISSUE-ID-OR-ISSUE-LINK`
|
||||
- `@sentry create a {% data variables.product.prodname_dotcom %} issue for the most recent Sentry issue and assign it to @DEVELOPER`
|
||||
|
||||
For information on the best ways to use a specific {% data variables.product.prodname_copilot_extension_short %}, read the description of the extension on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=apps&copilot_app=true).
|
||||
- Interactions with one {% data variables.product.prodname_copilot_extension_short %} will never be shared with another {% data variables.product.prodname_copilot_extension_short %}. To interact with different {% data variables.product.prodname_copilot_extensions_short %} in an IDE, change the `@EXTENSION-NAME` at the beginning of each sentence. Interactions with different extensions will appear in the same {% data variables.product.prodname_copilot_chat_short %} window, but the conversations themselves are automatically separated.
|
||||
|
||||
{% ifversion ghec %} To interact with different {% data variables.product.prodname_copilot_extensions_short %} on {% data variables.product.prodname_dotcom_the_website %}, you need to start a new conversation for each extension by clicking {% octicon "plus" aria-label="New conversation" %} at the top of the {% data variables.product.prodname_copilot_chat_short %} window.{% endif %}
|
||||
Reference in New Issue
Block a user