Skip to main content

Analyze a .NET project using upgrade-assistant

org.openrewrite.dotnet.UpgradeAssistantAnalyze

Run upgrade-assistant analyze across a repository to analyze changes required to upgrade projects to a newer version of .NET. This recipe will generate an org.openrewrite.dotnet.UpgradeAssistantAnalysis data table containing the report details.

Recipe source

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options

TypeNameDescriptionExample
StringtargetFrameworkTarget framework to which source project should be upgraded.net9.0
StringprivacyModeSpecifies how much data is included in the generated data table. Valid options: Unrestricted, Protected, RestrictedRestricted

Usage

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.UpgradeAssistantAnalyzeExample
displayName: Analyze a .NET project using upgrade-assistant example
recipeList:
- org.openrewrite.dotnet.UpgradeAssistantAnalyze:
targetFramework: net9.0
privacyMode: Restricted

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe UpgradeAssistantAnalyze --recipe-option "targetFramework=net9.0" --recipe-option "privacyMode=Restricted"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-dotnet:0.9.0

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables

Upgrade-assistant analysis

org.openrewrite.dotnet.UpgradeAssistantAnalysis

.NET project upgrade analysis report generated by upgrade-assistant.

Column NameDescription
Project pathThe path of the analyzed project file.
Source pathThe path of the analyzed source file.
IssueIssue.
DescriptionDescription of issue.
Code snippetCode snippet raising issue.
RecommendationRecommendation to address issue.
LinkLink to further documentation related to updating the source file.