Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/sync-sdk-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ on:
types: [opened, synchronize, reopened]
paths:
- '.github/workflows/sync-sdk-docs.yml'
- 'content/copilot/get-started/sdk-quickstart.md'
- 'src/workflows/sync-sdk-docs/**'

concurrency:
Expand Down Expand Up @@ -77,6 +78,10 @@ jobs:
- name: Copy SDK docs
run: |
mkdir -p "$SDK_DOCS_TARGET"
# Pages relocated out of this tree into hand-authored content are not
# excluded here — they are removed by the RELOCATED_PAGES map in
# src/workflows/sync-sdk-docs/normalize-sdk-docs.ts, which also
# repoints inbound links at their new URLs.
rsync -av --exclude='.validation/' --exclude='developer-docs/' "$SDK_TMP/docs/" "$SDK_DOCS_TARGET/"
echo "Copied $(find "$SDK_DOCS_TARGET" -name '*.md' | wc -l | tr -d ' ') markdown files"

Expand Down
Binary file modified assets/images/help/pull_requests/abandon-review-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can also stream agent session activity from {% data variables.product.prodna

You can set up{% ifversion pause-audit-log-stream %}, pause,{% endif %} or delete a stream at any time. The stream exports audit and Git events data for all of the organizations in your enterprise, for activity from the time the stream is enabled onwards.

All streamed audit logs are sent as compressed JSON files. The filename format is in`YYYY/MM/HH/MM/<uuid>.json.gz`.
All streamed audit logs are sent as compressed JSON files. The filename format is `YYYY/MM/DD/HH/MM/<uuid>.json.log.gz`.

>[!NOTE] {% data variables.product.prodname_dotcom %} uses an at-least-once delivery method. Due to certain network or system issues, some events may be duplicated.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,31 +173,19 @@ When you use {% data variables.product.prodname_actions %} to generate attestati

{% ifversion fpt or ghec %}

Public repositories:
* **Dependency graph:** Enabled by default and cannot be disabled.
* **Dependency review:** Enabled by default and cannot be disabled.
* **{% data variables.product.prodname_dependabot_alerts %}:** Not enabled by default. {% data variables.product.prodname_dotcom %} detects insecure dependencies and displays information in the dependency graph, but does not generate {% data variables.product.prodname_dependabot_alerts %} by default. Repository owners or people with admin access can enable {% data variables.product.prodname_dependabot_alerts %}.
You can also enable or disable Dependabot alerts for all repositories owned by your user account or organization. For more information, see [AUTOTITLE](/account-and-profile/how-tos/account-settings/managing-security-and-analysis-features) or [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization).
* **Dependency graph:** Not enabled by default. Available for all repositories, and can be enabled or disabled by repository administrators.
* **Dependency review:** Available when the dependency graph is enabled. For private repositories, the repository must also be owned by an organization that uses {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} and has a license for {% data variables.product.prodname_GHAS_or_code_security %}.
* **{% data variables.product.prodname_dependabot_alerts %}:** Not enabled by default. Repository owners or people with admin access can enable {% data variables.product.prodname_dependabot_alerts %} for repositories that have the dependency graph enabled.
You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see [AUTOTITLE](/account-and-profile/how-tos/account-settings/managing-security-and-analysis-features) or [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization).
* **{% data variables.product.prodname_dependabot_security_updates %}:** Not enabled by default. You can enable {% data variables.product.prodname_dependabot_security_updates %} for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. See [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-security-updates).
* **{% data variables.product.prodname_dependabot_version_updates %}:** Not enabled by default. People with write permissions to a repository can enable {% data variables.product.prodname_dependabot_version_updates %}. See [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-version-updates).
* **Immutable releases:** Not enabled by default. You can enable release immutability for a repository or organization. See [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/prevent-release-changes).
* **Artifact attestations:** Available in all public repositories, but you must explicitly generate attestations in your build workflows. See [AUTOTITLE](/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations).

Private repositories:
* **Dependency graph:** Not enabled by default. The feature can be enabled by repository administrators. For more information, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/explore-dependencies).
* **Dependency review:** Available in private repositories owned by organizations that use {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GHAS_or_code_security %}. For more information, see [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security) and [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/explore-dependencies).
* **{% data variables.product.prodname_dependabot_alerts %}:** Not enabled by default. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories.
You can also enable or disable Dependabot alerts for all repositories owned by your user account or organization. For more information, see [AUTOTITLE](/account-and-profile/how-tos/account-settings/managing-security-and-analysis-features) or [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization).
* **Artifact attestations:** Only available in private repositories on {% data variables.product.prodname_ghe_cloud %}.

Any repository type:
* **{% data variables.product.prodname_dependabot_security_updates %}:** Not enabled by default. You can enable {% data variables.product.prodname_dependabot_security_updates %} for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For information about enabling security updates, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-security-updates).
* **{% data variables.product.prodname_dependabot_version_updates %}:** Not enabled by default. People with write permissions to a repository can enable {% data variables.product.prodname_dependabot_version_updates %}. For information about enabling version updates, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-version-updates).
* **Immutable releases*:** Not enabled by default. You can enable release immutability for a repository or organization. See [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/prevent-release-changes).
{% endif %}

{% ifversion ghes %}
* **Dependency graph and {% data variables.product.prodname_dependabot_alerts %}:** Not enabled by default. Both features are configured at an enterprise level by the enterprise owner. For more information, see [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/enable-dependency-graph) and [AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-dependabot-for-your-enterprise).
* **Dependency review:** Available when dependency graph is enabled for your instance and {% data variables.product.prodname_GHAS_or_code_security %} is enabled for the organization or repository. For more information, see [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security).
{% endif %}
{% ifversion ghes %}
* **{% data variables.product.prodname_dependabot_security_updates %}:** Not enabled by default. You can enable {% data variables.product.prodname_dependabot_security_updates %} for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For information about enabling security updates, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-security-updates).
* **{% data variables.product.prodname_dependabot_version_updates %}:** Not enabled by default. People with write permissions to a repository can enable {% data variables.product.prodname_dependabot_version_updates %}. For information about enabling version updates, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-version-updates).
{% endif %}
{% endif %}
1 change: 1 addition & 0 deletions content/copilot/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ children:
- /quickstart
- /cli-quickstart
- /quickstart-copilot-app
- /sdk-quickstart
- /what-is-github-copilot
- /plans
- /features
Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
---
title: Build your first Copilot-powered app
shortTitle: Getting Started
shortTitle: Copilot SDK quickstart
allowTitleToDifferFromFilename: true
intro: >-
In this tutorial, you'll use the Copilot SDK to build a command-line
assistant. You'll start with the basics, add streaming responses, then add
custom tools - giving Copilot the ability to call your code.
versions:
fpt: '*'
ghec: '*'
feature: copilot
redirect_from:
- /copilot/how-tos/copilot-sdk/sdk-getting-started
contentType: how-tos
- /copilot/how-tos/copilot-sdk/getting-started
contentType: get-started
category:
- Quickstarts
- Integrate Copilot with your tools
---

<!-- markdownlint-disable GHD046 GHD005 -->
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -->

**What you'll build:**

```text
Expand Down
2 changes: 1 addition & 1 deletion content/copilot/how-tos/copilot-sdk/auth/authenticate.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,5 +404,5 @@ const client = new CopilotClient({
## Next steps

* [AUTOTITLE](/copilot/how-tos/copilot-sdk/auth/byok) - Learn how to use your own API keys
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started) - Build your first Copilot-powered app
* [AUTOTITLE](/copilot/get-started/sdk-quickstart) - Build your first Copilot-powered app
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/mcp) - Connect to external tools
2 changes: 1 addition & 1 deletion content/copilot/how-tos/copilot-sdk/auth/byok.md
Original file line number Diff line number Diff line change
Expand Up @@ -594,4 +594,4 @@ foundry model run phi-4-mini
## Next steps

* [AUTOTITLE](/copilot/how-tos/copilot-sdk/auth) - Learn about all authentication methods
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started) - Build your first Copilot-powered app
* [AUTOTITLE](/copilot/get-started/sdk-quickstart) - Build your first Copilot-powered app
2 changes: 1 addition & 1 deletion content/copilot/how-tos/copilot-sdk/features/hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -890,7 +890,7 @@ For full type definitions, input/output field tables, and additional examples fo

## See also

* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started)
* [AUTOTITLE](/copilot/get-started/sdk-quickstart)
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/custom-agents)
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/streaming-events)
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/troubleshooting/debugging)
2 changes: 1 addition & 1 deletion content/copilot/how-tos/copilot-sdk/features/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ For detailed debugging guidance, see the **[AUTOTITLE](/copilot/how-tos/copilot-
* [Model Context Protocol Specification](https://modelcontextprotocol.io/)
* [MCP Servers Directory](https://github.com/modelcontextprotocol/servers) - Community MCP servers
* [GitHub MCP Server](https://github.com/github/github-mcp-server) - Official GitHub MCP server
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started) - SDK basics and custom tools
* [AUTOTITLE](/copilot/get-started/sdk-quickstart) - SDK basics and custom tools
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/troubleshooting/debugging) - SDK-wide debugging

## See also
Expand Down
4 changes: 2 additions & 2 deletions content/copilot/how-tos/copilot-sdk/features/skills.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,6 @@ If multiple skills provide conflicting instructions:

## See also

* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started#create-custom-agents) - Define specialized AI personas
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started#step-4-add-a-custom-tool) - Build your own tools
* [AUTOTITLE](/copilot/get-started/sdk-quickstart#create-custom-agents) - Define specialized AI personas
* [AUTOTITLE](/copilot/get-started/sdk-quickstart#step-4-add-a-custom-tool) - Build your own tools
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/mcp) - Connect external tool providers
Original file line number Diff line number Diff line change
Expand Up @@ -546,7 +546,7 @@ class InteractiveChat {

## See also

* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started): Set up a session and send messages
* [AUTOTITLE](/copilot/get-started/sdk-quickstart): Set up a session and send messages
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/custom-agents): Define specialized agents with scoped tools
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/hooks/hooks-overview): React to session lifecycle events
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/session-persistence): Resume sessions across restarts
4 changes: 2 additions & 2 deletions content/copilot/how-tos/copilot-sdk/hooks/hooks-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,6 @@ const session = await client.createSession({

## See also

* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started)
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started#step-4-add-a-custom-tool)
* [AUTOTITLE](/copilot/get-started/sdk-quickstart)
* [AUTOTITLE](/copilot/get-started/sdk-quickstart#step-4-add-a-custom-tool)
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/troubleshooting/debugging)
1 change: 0 additions & 1 deletion content/copilot/how-tos/copilot-sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ versions:
ghec: '*'
contentType: how-tos
children:
- /getting-started
- /auth
- /features
- /hooks
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The Microsoft Agent Framework is the unified successor to Semantic Kernel and Au

Before you begin, ensure you have:

* A working [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started) in your language of choice
* A working [AUTOTITLE](/copilot/get-started/sdk-quickstart) in your language of choice
* A GitHub Copilot subscription (Individual, Business, or Enterprise)
* The Copilot CLI installed or available via the SDK's bundled CLI

Expand Down Expand Up @@ -593,7 +593,7 @@ client.stop().get();

### Copilot SDK options (passed through)

All standard [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started) options are still available when creating the underlying Copilot client. The MAF wrapper delegates to the SDK under the hood:
All standard [AUTOTITLE](/copilot/get-started/sdk-quickstart) options are still available when creating the underlying Copilot client. The MAF wrapper delegates to the SDK under the hood:

| SDK Feature | MAF Support |
|-------------|-------------|
Expand Down Expand Up @@ -661,7 +661,7 @@ catch (AgentException ex)

## See also

* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started): initial Copilot SDK setup
* [AUTOTITLE](/copilot/get-started/sdk-quickstart): initial Copilot SDK setup
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/custom-agents): define specialized sub-agents within the SDK
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/skills): reusable prompt modules
* [Microsoft Agent Framework documentation](https://learn.microsoft.com/en-us/agent-framework/agents/providers/github-copilot): official MAF docs for the Copilot provider
Expand Down
2 changes: 1 addition & 1 deletion content/copilot/how-tos/copilot-sdk/setup/bundled-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,4 +215,4 @@ Session state persists at `~/.copilot/session-state/{sessionId}/`.

* **[AUTOTITLE](/copilot/how-tos/copilot-sdk/auth/byok)**: Use your own model provider keys
* **[AUTOTITLE](/copilot/how-tos/copilot-sdk/features/session-persistence)**: Advanced session management
* **[AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started)**: Build a complete app
* **[AUTOTITLE](/copilot/get-started/sdk-quickstart)**: Build a complete app
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ All guides assume you have:
* Go: `go get github.com/github/copilot-sdk/go` (requires separate CLI installation)
* .NET: `dotnet add package GitHub.Copilot.SDK`

If you're brand new, start with the **[AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started)** first, then come back here for production configuration.
If you're brand new, start with the **[AUTOTITLE](/copilot/get-started/sdk-quickstart)** first, then come back here for production configuration.

## Next steps

Expand Down
2 changes: 1 addition & 1 deletion content/copilot/how-tos/copilot-sdk/setup/local-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,5 +177,5 @@ Session state is stored locally at `~/.copilot/session-state/{sessionId}/`.
## Next steps

* **[AUTOTITLE](/copilot/how-tos/copilot-sdk/setup/bundled-cli)**: Use the SDK's built-in CLI (recommended for most use cases)
* **[AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started)**: Build a complete interactive app
* **[AUTOTITLE](/copilot/get-started/sdk-quickstart)**: Build a complete interactive app
* **[AUTOTITLE](/copilot/how-tos/copilot-sdk/auth/authenticate)**: All auth methods in detail
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ console.log("Protocol version:", status.protocolVersion);

## See also

* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started)
* [AUTOTITLE](/copilot/get-started/sdk-quickstart)
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/hooks/hooks-overview)
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/mcp)
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/troubleshooting/debugging)
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ If you're still stuck:

## See also

* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started)
* [AUTOTITLE](/copilot/get-started/sdk-quickstart)
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/mcp) - MCP configuration and setup
* [AUTOTITLE](/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging) - Detailed MCP troubleshooting
* [API Reference](https://github.com/github/copilot-sdk)
Loading
Loading