upgrade-assistant/CHANGELOG.md

Changelog

All notable changes to the .NET Upgrade Assistant will be documented in this file. Version numbers below will follow (best effort) the corresponding NuGet package versions here: https://www.nuget.org/packages/upgrade-assistant/

The format is based on Keep a Changelog.

Version 0.2.237901 - 2021-07-30 (Link)

Changed

• Updated try-convert tool version from 0.7.226301 to 0.9.232202

Added

• Added command line argument to select VS version (--vs-path) in cases where multiple are installed #753
• Added analyzers for identifying common namespaces, types, and members that require manual fixup and will produce diagnostics with links to relevant docs. The list of APIs identified by the analyzer can be expanded by adding to DefaultApiAlerts.json or by adding a .apitargets file to a project's additional files. #685
• Link to survey #735

Version 0.2.236301 - 2021-07-15 (Link)

Added

• analyze command to provide pre-upgrade package analysis and produce a sarif log of the results #24
• Validation diagram to help maintain the architectural decisions so far and codify it into the build process. #696

Fixed

• Fixed regression where --skip-backup and --entrypoint options were not being passed through #695

Version 0.2.233001 - 2021-06-30 (Link)

Added

• New project readiness checks evaluate if the project contains unsupported technologies to increase awareness before users invest significant time trying to upgrade. #617
• Usage telemetry has been added to help guide product development. See https://aka.ms/upgrade-assistant-telemetry for details #644.
• Command line option to pass options through in the form of --option KEY=Value #651
• Added an analyzer and code fix provider to remove unnecessary attributes and upgrade changed attributes (based on type mappings in registered typemap files) #641
• The SourceUpdaterStep and RazorSourceUpdater will now alert the user of any diagnostics from registered analyzers that require manual fixups (because no code fix was available). This allows Upgrade Assistant to notify users of code patterns that it can identify as needing updated but is unable to update automatically. #662
• Added RemoveProperty method to enable removal of a property from the project file. #668

Fixed

• Updated HttpContext.Current analyzer to more correctly identify uses of HttpContext.Current that need replaced #628.
• The Upgrade Assistant analyzer package no longer adds a WebTypeReplacements.typemap file to projects it's added to (more precisely, the file is present and available for analyzers to use but isn't visible in the solution explorer anymore) #632.
• Addressed compile time errors that surfaced from Visual Basic Runtime and the My. namespace (Link)
• Exposed Sdk in IProjectFile to enable development of custom extensions to add/remove Sdk. #614

Version 0.2.231403 - 2021-06-14 (Link)

Fixed

• Updated HttpContext.Current code fix to use an internal HttpContextHelper that will work in multi-project solutions #599.
• Fixed a bug that was preventing the Upgrade Assistant analyzer package from being added to upgraded projects #620.
• Fixed a bug in PackageLoader that was causing many extraneous warning messages when verbose logging was enabled #619.
• Fixed a bug in SourceUpdaterStep that was leaving an extra .cs file in projects after upgrade which introduced build errors in the project (since the .cs files were already automatically included) #616.
• Exposed Imports in IProjectFile to enable development of custom extensions to add/remove imports. #612

Version 0.2.227701 - 2021-05-27 (Link)

Added

• Added an analyzer and code fix provider to upgrade System.Web.Mvc.Controller to Microsoft.AspNetCore.Mvc.Controller #534
• Added additional code fixer for HttpContext.Current that will replace calls with method injection #536
• Added a Razor upgrade sub-step to replace @helper functions in Razor views with local methods #559
• Analyzers that recommend replacing one type with another are now combined into a single analyzer (TypeUpgradeAnalyzer) with behavior that can be customized via AdditionalTexts containing old -> new type mappings #540
• BinaryFormatterUnsafeDeserializer now works with Visual Basic #544

Fixed

• VB projects that have a MyType property that requires Windows will now default to net5.0-windows #529
• Restores are now more likely to be performed if needed so errors about finding targets won't be surfaced. A clearer message will be surfaced as well if this occurs. #525
• Updated the ApiController upgrade code fix provider to upgrade to Microsoft.AspNetCore.Mvc.ControllerBase instead of Microsoft.AspNetCore.Mvc.Controller #534

Breaking change

• Upgrade path now uses the command upgrade. In order to use the tool to upgrade projects, the command looks like upgrade-assistant upgrade <Path to csproj or sln to upgrade> #541

Version 0.2.226201 - 2021-05-12 (Link)

Added

• A new command line option (--target-tfm-support to select the support model of LTS/Preview/Current that is desired #469

Fixed

• VB Win Forms projects should keep import for 'System.Windows.Forms' #474

Version 0.2.222702 - 2021-04-27 (Link)

Added

• Multiple entrypoints can now be added by using globbing and multiple instances of the --entry-point argument #425
• NuGet credential providers will now be used, if present (may require running in interactive mode) #448
• Source analyzers and code fix providers are now applied to source embedded in Razor documents #455
• Persist Backup path in .upgrade-assistant state file #447 Thanks for the PR, @oteione!

Fixed

• UpgradeSteps should be filtered based on project components #255
• Do not add _ViewImports.cshtml to VB projects #378

Breaking change

• The commandline argument -e is now shorthand for --entry-point rather than --extension #425

Version 0.2.220602 - 2021-04-06 (Link)

Added

• Added support for WPF and Unit Test projects written with Visual Basic #403

Fixed

• Allows projects to be read if they have multiple TFMs. The tool still can't upgrade them, but it won't block upgrading dependent projects #379
• Fixed issue surfacing from floating package references #371
• Microsoft.AspNetCore.Mvc.NewtonsoftJson package should no longer be added to .NET Framework projects #376
• Fixed issue to ignore disabled NuGet sources #396
• Ensured restore is run when required #402

Version 0.2.217201 - 2021-03-23 (Link)

Added

• Include try-convert version in upgrade-assistant package #358
• Add check to ensure project files can be successfully loaded prior to upgrading them. #346
• Add a command to select a different current project #343
• Add a step to update package dependecies before TFM change #342
• Add a source updater to update BinaryFormatter.UnsafeDeserialize calls to BinaryFormatter.Deserialize in appropriate cases. #339
• Be sure to include log exception information if upgrade steps fail #335
• Update package updater to upgrade System.Configuration and System.Data.Entity references. #324
• Include try-convert as part of build #322
• More extensibility samples and docs #305
• Add support to load VB project files #299
• Add support for PCL #294
• Add trouble-shooting tips for installing with invalid/auth NuGet sources #291
• Add a sample demonstrating how to make a custom upgrade step #283
• Add option to provide entry-point and make non-interactive mode visible #282
• Add a way to verify upgrade readiness #279
• Allow controlling file/console logging independently #278
• Add SetPropertyValue to IProjectFile and MSBuildProject.File #274

Changed

• Update web references in libraries #354
• Don't save 'upgrade complete' in state file #352
• Set an error code if the app terminates unexpectedly #348
• Allow sub-steps to be conditional on project components #317
• Sets the default serializer to Newtonsoft for Web Apps to improve backward compatibility #306
• Tool now exits with error if run from non-Windows machine #281
• Change to only target windows for now #264
• Package Microsoft.DotNet.UpgradeAssistant.Extensions as a NuGet package #261

Fixed

• Don't prompt the user to select a current project if all projects related to the entry point are upgraded. #351
• Fix bugs when upgrading just one project in a larger solution and updated ready checks to apply per-project instead of solution-wide. #314

Removed

• Remove MSBuild from being included in projects #325

Version 0.2.212405 - Preview 1 - 2021-02-24 (Link)

The Preview 1 release, was the first public release that supports upgrading ASP.NET MVC, Windows Forms, WPF, Console, and Class Libraries .NET Framework applications to .NET 5.