-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Update GHCP AppMod docs: scenarios, platforms, and titles #54664
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
67281fc
9586563
7b60cc6
1ed59cf
373e20c
ccf1c36
46a432d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| author: adegeo | ||
| ms.author: adegeo | ||
| ms.date: 07/07/2026 | ||
| ms.topic: include | ||
| --- | ||
|
|
||
| | Source | Target | | ||
| |------------------------------|---------------------------| | ||
| | .NET Framework (any version) | .NET 8 or later | | ||
| | .NET Framework (any version) | .NET Framework 4.8.1 | | ||
| | .NET Core 1.x–3.x | .NET 8 or later | | ||
| | .NET 5 or later | .NET 8 or later | |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |||||
| title: Install GitHub Copilot modernization | ||||||
| description: "Learn how to install and set up GitHub Copilot modernization across Visual Studio, Visual Studio Code, GitHub Copilot CLI, and GitHub.com." | ||||||
| ms.topic: install-set-up-deploy | ||||||
| ms.date: 04/06/2026 | ||||||
| ms.date: 07/07/2026 | ||||||
| ai-usage: ai-assisted | ||||||
| zone_pivot_groups: copilot-modernization-install | ||||||
|
|
||||||
|
|
@@ -22,14 +22,14 @@ Before you install, make sure you have: | |||||
|
|
||||||
| - Windows operating system. | ||||||
| - [Visual Studio 2026](https://visualstudio.microsoft.com/downloads/) (or Visual Studio 2022 version 17.14.17+). | ||||||
| - [.NET desktop development workload](/visualstudio/install/modify-visual-studio?view=visualstudio&preserve-view=true#change-workloads-or-individual-components) with these optional components enabled: **GitHub Copilot**, **GitHub Copilot modernization**. | ||||||
| - [.NET desktop development workload](/visualstudio/install/modify-visual-studio?view=visualstudio&preserve-view=true#change-workloads-or-individual-components) with these optional components enabled: **GitHub Copilot**, **GitHub Copilot app modernization**. | ||||||
| - GitHub Copilot subscription (paid or free). | ||||||
| - [Sign in to Visual Studio with a GitHub account](/visualstudio/ide/work-with-github-accounts) that has [Copilot access](https://docs.github.com/copilot/get-started/plans#ready-to-choose-a-plan). | ||||||
| - Code written in C# or Visual Basic. | ||||||
|
|
||||||
| ## Install | ||||||
|
|
||||||
| Visual Studio includes GitHub Copilot modernization, so you don't need to install it separately. Enable the **GitHub Copilot** and **GitHub Copilot modernization** optional components in the **.NET desktop development** workload through the Visual Studio Installer. | ||||||
| Visual Studio includes GitHub Copilot modernization through the **GitHub Copilot app modernization** optional component, so you don't need to install it separately. Enable the **GitHub Copilot** and **GitHub Copilot app modernization** optional components in the **.NET desktop development** workload through the Visual Studio Installer. | ||||||
|
|
||||||
| ## Verify the installation | ||||||
|
|
||||||
|
|
@@ -50,16 +50,23 @@ Before you install, make sure you have: | |||||
|
|
||||||
| ## Install | ||||||
|
|
||||||
| Install through the Visual Studio Code: | ||||||
|
|
||||||
| 1. In Visual Studio Code, open the **Extensions** view (<kbd>Ctrl+Shift+X</kbd>). | ||||||
| 1. Search for **GitHub Copilot modernization**. | ||||||
| 1. Search for **GitHub Copilot upgrade**. | ||||||
| 1. Select **Install**. | ||||||
|
|
||||||
| The extension automatically acquires the .NET SDK if it's missing, registers tools, and adds the agent to Copilot Chat as `modernize-dotnet`. | ||||||
| The extension automatically acquires the .NET SDK if it's missing, registers tools, and adds the agent to Copilot Chat as `Upgrade`. | ||||||
|
|
||||||
| ## Verify the installation | ||||||
|
|
||||||
| 1. Open a project in Visual Studio Code. | ||||||
| 1. Open **GitHub Copilot Chat** and type `@modernize-dotnet`. | ||||||
| 1. Open the **GitHub Copilot Chat** window. | ||||||
| 1. Send `@upgrade` in chat and see if it responds. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Very minor: take or leave. |
||||||
|
|
||||||
| \-or- | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Seperator was escaped or was a typo, elsewhere -or- is used so making this one the same. |
||||||
|
|
||||||
| Select the `Agent` dropdown and find the `Upgrade` entry. | ||||||
|
|
||||||
| ::: zone-end | ||||||
|
|
||||||
|
|
@@ -69,52 +76,58 @@ The extension automatically acquires the .NET SDK if it's missing, registers too | |||||
|
|
||||||
| Before you install, make sure you have: | ||||||
|
|
||||||
| - GitHub Copilot CLI installed. | ||||||
| - [GitHub Copilot CLI](https://gh.io/cli) installed. | ||||||
| - GitHub Copilot subscription (paid or free). | ||||||
|
|
||||||
| ## Install | ||||||
|
|
||||||
| To install: | ||||||
| Install through the GitHub Copilot CLI: | ||||||
|
|
||||||
| 1. Open the GitHub Copilot chat window. | ||||||
|
|
||||||
| 1. Add the marketplace plugin: | ||||||
|
|
||||||
| ```console | ||||||
| /plugin marketplace add dotnet/modernize-dotnet | ||||||
| /plugin marketplace add microsoft/upgrade-agent-plugins | ||||||
| ``` | ||||||
|
|
||||||
| 1. Install the plugin: | ||||||
|
|
||||||
| ```console | ||||||
| /plugin install modernize-dotnet@modernize-dotnet-plugins | ||||||
| /plugin install upgrade-agent@upgrade-agent-plugins | ||||||
| ``` | ||||||
|
|
||||||
| ## Verify the installation | ||||||
|
|
||||||
| Run `/agent` to confirm that `modernize-dotnet` appears in the agent list. | ||||||
| Run `/agent` to confirm that `upgrade-agent` appears in the agent list. | ||||||
|
|
||||||
| ::: zone-end | ||||||
|
|
||||||
| ::: zone pivot="github-com" | ||||||
| ::: zone pivot="github-copilot-app" | ||||||
|
|
||||||
| ## Prerequisites | ||||||
|
|
||||||
| Before you install, make sure you have: | ||||||
|
|
||||||
| - GitHub Copilot Enterprise or Business subscription with coding agents enabled. | ||||||
| - Repository admin access. | ||||||
| - [GitHub Copilot app](https://gh.io/app) installed. | ||||||
| - GitHub Copilot subscription (paid or free). | ||||||
|
|
||||||
| ## Install | ||||||
|
|
||||||
| Add the custom coding agent to your repository: | ||||||
| Install through the GitHub Copilot app: | ||||||
|
|
||||||
| 1. Review [adding custom coding agents to your repository](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). | ||||||
| 1. Add the `modernize-dotnet` agent. See the [coding agent README](https://github.com/dotnet/modernize-dotnet/blob/main/coding-agent/README.md) for details. | ||||||
| 1. Click on [this link](https://github.com/copilot/app/launch?entry_point=upgrade_agent_docs&open=ghapp%3A%2F%2Fplugins%2Fmarketplace%2Fadd%3Fsource%3Dmicrosoft%2Fupgrade-agent-plugins) to automatically open the **Settings** > **Plugins** window in the GitHub Copilot app. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| 1. In the **Add plugin marketplace?** dialog, select **Allow**. | ||||||
| 1. In the **Plugins** window, select **Add marketplace**. | ||||||
| 1. Expand the **upgrade-agent-plugins** entry and select **Install** on the **upgrade-agent** plugin. | ||||||
|
|
||||||
| ## Verify the installation | ||||||
|
|
||||||
| Confirm that the `modernize-dotnet` agent appears as an available coding agent in your repository. | ||||||
| Run `/agent` to confirm that `upgrade-agent:upgrade` appears in the agent list. | ||||||
|
|
||||||
| -or- | ||||||
|
|
||||||
| Select the **Default agent** dropdown and find the **Upgrade** entry. | ||||||
|
|
||||||
| ::: zone-end | ||||||
|
|
||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,7 +3,7 @@ title: GitHub Copilot modernization overview | |||||
| description: "Learn about GitHub Copilot modernization, a Copilot agent available across Visual Studio, Visual Studio Code, GitHub Copilot CLI, and GitHub.com that upgrades .NET projects and migrates apps to Azure." | ||||||
| titleSuffix: "" | ||||||
| ms.topic: overview | ||||||
| ms.date: 04/06/2026 | ||||||
| ms.date: 07/07/2026 | ||||||
| ai-usage: ai-assisted | ||||||
|
|
||||||
| #customer intent: As a developer, I want to learn about what GitHub Copilot modernization is, so that I understand its capabilities and how I can take advantage of it. | ||||||
|
|
@@ -36,6 +36,9 @@ The agent provides multiple end-to-end modernization workflows called _scenarios | |||||
| | **SqlClient upgrade** | Upgrades from System.Data.SqlClient to Microsoft.Data.SqlClient. | _"Update SqlClient"_ | | ||||||
| | **Azure Functions upgrade** | Upgrades Azure Functions from in-process to isolated worker model. | _"Upgrade my Azure Functions"_ | | ||||||
| | **Semantic Kernel to Agents** | Upgrades Semantic Kernel Agents to Microsoft Agent Framework. | _"Upgrade my SK agents"_ | | ||||||
| | **Aspire integration** | Adds .NET Aspire support for inner-loop and Azure deployment. | _"Add Aspire to my app"_ | | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| | **Aspire version upgrade** | Upgrades existing Aspire applications to newer versions. | _"Upgrade my Aspire version"_ | | ||||||
| | **WebForms-to-Blazor upgrade** | Upgrades ASP.NET Web Forms applications to Blazor. | _"Migrate my Web Forms app to Blazor"_ | | ||||||
|
|
||||||
| For a full reference of all scenarios and 30+ built-in upgrade skills, see [Scenarios and skills reference](scenarios-and-skills.md). | ||||||
|
|
||||||
|
|
@@ -45,7 +48,7 @@ Microsoft values your feedback and uses it to improve the agent. Leave feedback | |||||
|
|
||||||
| - In Visual Studio, use the [Suggest a feature](/visualstudio/ide/suggest-a-feature) and [Report a problem](/visualstudio/ide/report-a-problem) options. | ||||||
|
|
||||||
| - File an issue at the [@modernize-dotnet GitHub repository](https://github.com/dotnet/modernize-dotnet). | ||||||
| - File an issue at the [Upgrade Agent GitHub repository](https://github.com/microsoft/upgrade-agent-plugins). | ||||||
|
|
||||||
| ## Prerequisites | ||||||
|
|
||||||
|
|
@@ -73,11 +76,7 @@ To start an upgrade, see [Upgrade a .NET app with GitHub Copilot modernization]( | |||||
|
|
||||||
| The agent supports the following upgrade paths: | ||||||
|
|
||||||
| | Source | Target | | ||||||
| |------------------------------|-----------------| | ||||||
| | .NET Framework (any version) | .NET 8 or later | | ||||||
| | .NET Core 1.x–3.x | .NET 8 or later | | ||||||
| | .NET 5 or later | .NET 8 or later | | ||||||
| [!INCLUDE[supported-upgrade-paths](./includes/supported-upgrade-paths.md)] | ||||||
|
|
||||||
| ## Migrate .NET projects to Azure | ||||||
|
|
||||||
|
|
@@ -193,7 +192,6 @@ The agent stores all upgrade state in `.github/upgrades/{scenarioId}/`. The fold | |||||
| | `plan.md` | Ordered task plan | | ||||||
| | `tasks.md` | Live progress dashboard | | ||||||
| | `scenario-instructions.md` | Agent's persistent memory, including preferences, decisions, and custom instructions | | ||||||
| | `execution-log.md` | Detailed audit trail of all changes | | ||||||
| | `tasks/{taskId}/task.md` | Per-task scope and context | | ||||||
| | `tasks/{taskId}/progress-details.md` | Per-task execution notes and results | | ||||||
|
|
||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |||||
| title: GitHub Copilot modernization scenarios and skills | ||||||
| description: "Complete reference of all scenarios and built-in upgrade skills available in GitHub Copilot modernization for .NET, organized by domain." | ||||||
| ms.topic: reference | ||||||
| ms.date: 04/06/2026 | ||||||
| ms.date: 07/07/2026 | ||||||
| ai-usage: ai-assisted | ||||||
|
|
||||||
| #customer intent: As a developer, I want to see all the scenarios and skills that GitHub Copilot modernization supports so that I can understand which upgrade tasks the agent can handle for me. | ||||||
|
|
@@ -33,18 +33,17 @@ Scenarios are the agent's top-level upgrade workflows. When you start a conversa | |||||
| | [**SqlClient upgrade**](#sqlclient-upgrade) | Upgrades System.Data.SqlClient to Microsoft.Data.SqlClient. | _"Update SqlClient to the modern package"_ | | ||||||
| | [**Azure Functions upgrade**](#azure-functions-upgrade) | Upgrades Azure Functions from in-process to isolated worker model. | _"Upgrade my Azure Functions"_ | | ||||||
| | [**Semantic Kernel to Agents**](#semantic-kernel-to-microsoft-agent-framework) | Upgrades from SK Agents to Microsoft Agent Framework. | _"Upgrade my SK agents"_ | | ||||||
| | [**Aspire integration**](#aspire-integration) | Adds .NET Aspire support for inner-loop and Azure deployment. | _"Add Aspire to my app"_ | | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| | [**Aspire version upgrade**](#aspire-version-upgrade) | Upgrades existing Aspire applications to newer versions. | _"Upgrade my Aspire version"_ | | ||||||
| | [**WebForms-to-Blazor upgrade**](#webforms-to-blazor-upgrade) | Upgrades ASP.NET Web Forms applications to Blazor. | _"Migrate my Web Forms app to Blazor"_ | | ||||||
|
|
||||||
| For an end-to-end walkthrough, see [Core concepts](concepts.md). | ||||||
|
|
||||||
| ### .NET version upgrade | ||||||
|
|
||||||
| The most common scenario. Upgrades your projects from any older .NET variant to the latest: | ||||||
|
|
||||||
| | Source | Target | | ||||||
| |------------------------------|-----------------| | ||||||
| | .NET Framework (any version) | .NET 8 or later | | ||||||
| | .NET Core 1.x–3.x | .NET 8 or later | | ||||||
| | .NET 5 or later | .NET 8 or later | | ||||||
| [!INCLUDE[supported-upgrade-paths](./includes/supported-upgrade-paths.md)] | ||||||
|
|
||||||
| The agent analyzes your dependency graph, checks NuGet compatibility, identifies breaking changes, and creates a task plan using the best strategy for your solution (bottom-up, top-down, or all-at-once). If your projects need format conversions, the agent handles them automatically as part of the upgrade. | ||||||
|
|
||||||
|
|
@@ -68,6 +67,18 @@ Upgrades Azure Functions from the in-process hosting model to the isolated worke | |||||
|
|
||||||
| Upgrades from Semantic Kernel Agents (`ChatCompletionAgent`, `OpenAIAssistantAgent`) to [Microsoft Agent Framework](/agent-framework/overview/). Updates packages and API patterns. | ||||||
|
|
||||||
| ### Aspire integration | ||||||
|
|
||||||
| Adds .NET Aspire support to existing applications for inner-loop development and Azure deployment. Configures the Aspire orchestration layer and integrates with the Aspire CLI agent. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ### Aspire version upgrade | ||||||
|
|
||||||
| Upgrades existing .NET Aspire applications to newer versions of Aspire. Handles package updates, configuration changes, and breaking API changes between Aspire versions. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ### WebForms-to-Blazor upgrade | ||||||
|
|
||||||
| Upgrades ASP.NET Web Forms applications to Blazor using native Blazor and HTML5 patterns. Converts Web Forms pages, controls, and code-behind to Blazor components. | ||||||
|
|
||||||
| ## Upgrade skills: common | ||||||
|
|
||||||
| General-purpose upgrade skills that apply across project types. | ||||||
|
|
@@ -94,6 +105,7 @@ Skills for upgrading data access layers, including Entity Framework, LINQ to SQL | |||||
| | **Upgrading EDMX to Code-First** | Converts EF6 Database-First (`.edmx`) models to EF Core Code-First. Scaffolds entities from the database. | | ||||||
| | **Upgrading EF DbContext** | Registers `DbContext` in ASP.NET Core dependency injection. Handles both EF6 to EF Core and existing EF Core patterns. | | ||||||
| | **Upgrading EF6 Code-First to EF Core** | Upgrades EF6 Code-First to EF Core. Swaps packages, updates namespaces, and replaces `EntityTypeConfiguration` and `DbModelBuilder`. | | ||||||
| | **Upgrading LINQ to SQL to EF Core** | Migrates LINQ to SQL (`System.Data.Linq`) data access to Entity Framework Core. | | ||||||
| | **Upgrading to Microsoft.Data.SqlClient** | Upgrades from `System.Data.SqlClient`. Handles the `Encrypt=true` default change and connection string differences. | | ||||||
|
|
||||||
| ## Upgrade skills: web and ASP.NET | ||||||
|
|
@@ -147,6 +159,7 @@ Skills for upgrading ASP.NET Framework applications to ASP.NET Core. | |||||
| | **Upgrading Azure Functions Startup** | Upgrades Azure Functions from the in-process `Startup` class to isolated worker model with `Program.cs`. | | ||||||
| | **Upgrading Azure Functions to v2** | Upgrades Azure Functions to the v2 hosting pattern using `IHostApplicationBuilder`. | | ||||||
| | **Upgrading Azure Key Vault** | Upgrades legacy Azure Key Vault SDK to the modern `Azure.Security.KeyVault` libraries. | | ||||||
| | **Upgrading Azure SDK** | Upgrades legacy Azure SDK dependencies to the latest `Azure.*` libraries. | | ||||||
| | **Upgrading Azure Service Bus** | Upgrades legacy Azure Service Bus SDK to the modern `Azure.Messaging.ServiceBus` library. | | ||||||
| | **Upgrading Azure Storage** | Upgrades legacy Azure Storage SDK to the modern `Azure.Storage` libraries. | | ||||||
|
|
||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.