-
Notifications
You must be signed in to change notification settings - Fork 6.1k
add working with assessment doc #49611
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
Open
zhoufenqin
wants to merge
1
commit into
dotnet:main
Choose a base branch
from
zhoufenqin:fenzho/add-assessment-doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+236 KB
...migration/appmod/media/configure-azure-service-target-for-assessment-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+164 KB
docs/azure/migration/appmod/media/import-assessment-report-in-chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+230 KB
...zure/migration/appmod/media/list-azure-service-target-for-assessment-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| --- | ||
| title: "Working with Assessment: Comprehensive guide to application assessment" | ||
| description: Learn how to effectively work with application assessments in GitHub Copilot app modernization, including configuration, interpretation, and report management. | ||
| author: KarlErickson | ||
| ms.author: karler | ||
| ms.reviewer: fenzho | ||
| ms.topic: concept-article | ||
| ms.date: 11/04/2025 | ||
| ms.custom: devx-track-dotnet | ||
| ai-usage: ai-assisted | ||
| --- | ||
|
|
||
| # Working with Assessment: Comprehensive guide to application assessment | ||
|
|
||
| This article shows you how to use assessment capabilities in GitHub Copilot app modernization to maximize the value of your application modernization process. | ||
|
|
||
| ## Overview | ||
|
|
||
| Application assessment is a critical first step in your modernization journey. This article shows you how to configure assessments for different scenarios, work with assessment reports, and manage assessment data throughout your modernization process. | ||
|
|
||
| ## Configure before running assessment | ||
|
|
||
| You can open the `.appmod/.appcat/assessment-config.json` file in your project to edit the configuration for application assessment to specify your target Azure service if it exists. For the first run of the assessment, the configuration file will be generated automatically. | ||
|
|
||
| :::image type="content" source="media/configure-azure-service-target-for-assessment-report.png" lightbox="media/configure-azure-service-target-for-assessment-report.png" alt-text="Screenshot of Visual Studio that shows the GitHub Copilot app modernization assessment configuration."::: | ||
|
|
||
|
|
||
| ### Configuration properties | ||
| You can edit this file to configure the application assessment. Any changes saved to this file will be applied the next time you run the assessment. | ||
|
|
||
| The configurable AppCAT arguments: | ||
|
|
||
| - Target: | ||
|
|
||
| Target means the Azure compute service to run the apps on. Choose "Any" if you haven't decided which one to use and later you can choose and compare on the assessment report. By default, it's set as `Any`. | ||
|
|
||
| | Target | Description | | ||
| |-----------------------------------|--------------------------------------------------------------------| | ||
| | Any | Discover issues for all supported targets here. | | ||
| | AKS.Windows | Best practices for Azure Kubernetes Service (Windows). | | ||
| | AKS.Linux | Best practices for Azure Kubernetes Service (Linux). | | ||
| | AppService.Windows | Best practices for Azure App Service (Windows). | | ||
| | AppService.Linux | Best practices for Azure App Service (Linux). | | ||
| | AppServiceContainer.Windows | Best practices for Azure App Service Container (Windows). | | ||
| | AppServiceContainer.Linux | Best practices for Azure App Service Container (Linux). | | ||
| | AppServiceManagedInstance.Windows | Best practices for Azure App Service Managed Instance (Windows). | | ||
| | ACA | Best practices for Azure Container Apps. | | ||
|
|
||
| ### Examples | ||
|
|
||
| The following are two examples of how to configure properly. | ||
|
|
||
| - Example one: You'd like to migrate your apps to Azure but haven't decided on the target compute service yet | ||
| ```json | ||
| { | ||
| "appcat": { | ||
| "target": "Any" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| - Example two: You'd like to migrate your apps to App Service Linux and want to understand what issues need to be fixed.' Also, 'what are the issues' is awkward phrasing | ||
| ```json | ||
| { | ||
| "appcat": { | ||
| "target": "AppService.Linux" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| After running an assessment, the interactive dashboard opens automatically, providing comprehensive analysis results. When you configure the AppCAT target Azure service as `Any`, you can switch between them to compare migration approaches and view service-specific recommendations. If you configure the target Azure service as a specific one, you can only see one Azure service in the dropdown list. | ||
|
|
||
| :::image type="content" source="./media/list-azure-service-target-for-assessment-report.png" lightbox="./media/list-azure-service-target-for-assessment-report.png" alt-text="Screenshot of Visual Studio showing the GitHub Copilot app modernization assessment dashboard with Azure service target selection options."::: | ||
|
|
||
| ## Interpreting assessment report | ||
|
|
||
| The assessment reports provide comprehensive analysis results to help you understand your application's readiness for Azure migration and modernization. This section guides you through the report structure and helps you interpret the findings to make informed migration decisions. | ||
|
|
||
| ### Report structure overview | ||
|
|
||
| The assessment report consists of several key sections: | ||
|
|
||
| - **Application Information**: Basic information about your application including project numbers, frameworks, build tools, and target Azure service. | ||
| - **Issue Summary**: Overview of migration issues categorized by domain with criticality percentages. | ||
| - **Issues**: Provides a concise summary of all issues that require attention. | ||
|
|
||
| :::image type="content" source="./media/assessment-report-dashboard.png" lightbox="./media/assessment-report-dashboard.png" alt-text="Screenshot of Visual Studio showing the GitHub Copilot app modernization assessment report dashboard."::: | ||
|
|
||
| #### Issues | ||
|
|
||
| The issues section provides a categorized list of various aspects of Cloud Readiness that you need to address to successfully migrate the application to Azure. The following tables describe the `Domain` and `Criticality` values: | ||
|
|
||
| | Domain | Description | | ||
| |---------------------|-----------------------------------------------------------------------------------------| | ||
| | **Cloud Readiness** | Evaluates app dependencies to suggest Azure services and ensure cloud-native readiness. | | ||
|
|
||
| | Criticality | Description | | ||
| |---------------------|---------------------------------------------------------------| | ||
| | **Mandatory** | Issues that must be fixed for migration to Azure. | | ||
zhoufenqin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | **Potential** | Issues that might impact migration and need review. | | ||
| | **Optional** | Low-impact issues. Fixing them is recommended but optional. | | ||
|
|
||
|
|
||
| For more information, you can expand each reported issue by selecting the title. The report provides the following information: | ||
|
|
||
| - A list of files where the incidents occurred, along with the number of code lines impacted. If the file is a .NET source file, then selecting the file line number directs you to the corresponding source report. | ||
| - A detailed description of the issue. This description outlines the problem, provides any known solutions, and references supporting documentation regarding either the issue or resolution. | ||
|
|
||
| :::image type="content" source="./media/assessment-report-issue-detail.png" lightbox="./media/assessment-report-issue-detail.png" alt-text="Screenshot of Visual Studio showing the GitHub Copilot app modernization assessment report issue details."::: | ||
|
|
||
| ## Operate assessment report | ||
|
|
||
| Effective report management enables collaboration, maintains assessment history, and integrates with existing workflows. | ||
|
|
||
| ### Import assessment report | ||
|
|
||
| Besides running the assessment directly in GitHub Copilot app modernization, you can also import assessment reports. The report can come from a .NET AppCAT CLI result, GitHub Copilot app modernization exported report, or app context file from Dr.Migrate. | ||
|
|
||
| You can trigger importing a report by typing "import assessment report" in the chat when you enter the `Modernize` agent, or select the `Import` button in the assessment dashboard to import the report from the file explorer. | ||
|
|
||
| :::image type="content" source="./media/import-assessment-report-in-chat.png" lightbox="./media/import-assessment-report-in-chat.png" alt-text="Screenshot of Visual Studio showing the GitHub Copilot app modernization assessment report import from chat."::: | ||
|
|
||
| :::image type="content" source="./media/import-assessment-report.png" lightbox="./media/import-assessment-report.png" alt-text="Screenshot of Visual Studio showing the GitHub Copilot app modernization assessment report import interface."::: | ||
|
|
||
| ### Export assessment report | ||
|
|
||
| In the assessment dashboard, you can view the issues detected by AppCAT and choose the migration solution. You can export the report and share it with others. This way, other people don't need to run the assessment themselves and can import the report to view the assessment and migration decisions directly. | ||
zhoufenqin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| You can select the `Export` button in the assessment dashboard to export the report to the file explorer. | ||
|
|
||
|
|
||
| :::image type="content" source="./media/export-assessment-report.png" lightbox="./media/export-assessment-report.png" alt-text="Screenshot of Visual Studio showing the GitHub Copilot app modernization assessment report export options and interface."::: | ||
|
|
||
|
|
||
|
|
||
| ## Next Steps | ||
|
|
||
| - [Predefined Tasks](predefined-tasks.md) | ||
| - [Frequently Asked Questions](../../../core/porting/github-copilot-app-modernization/faq.yml) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.