← All recipes
Moderne licensed

Analyze a .NET project using upgrade-assistant

Recipe IDorg.openrewrite.dotnet.UpgradeAssistantAnalyzeArtifactorg.openrewrite.recipe:rewrite-dotnet

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.

Single recipeProprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.dotnet.UpgradeAssistantAnalyze")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-dotnet:0.18.0")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.dotnet.UpgradeAssistantAnalyze --recipe-option "targetFramework=net9.0" --recipe-option "privacyMode=Restricted"

If the recipe isn’t available locally, install it with:

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

Options

NameTypeDescription
targetFrameworkrequiredStringTarget framework to which source project should be upgraded.
e.g. net9.0
privacyModerequiredStringSpecifies how much data is included in the generated data table.
e.g. Restricted

Data tables

Structured output this recipe can produce.

  • Upgrade-assistant analysis.NET project upgrade analysis report generated by upgrade-assistant.org.openrewrite.dotnet.UpgradeAssistantAnalysis
  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats