Automatic Sitecore NuGet upgrades with Powershell

November 2, 2021 Rodrigo Peplau 1

One of the most tedious tasks in any Sitecore upgrade is to update your NuGet references. If your projects have so many NuGet references on packages.config, and in special with Helix solutions, updating everything manually can take you several hours.

To the rescue, I’ve created this Powershell Script, which you can use to save your precious time.

What you need to download:

• The Powershell Script itself
• The CSV file with all Sitecore references from this article – Direct link to the CSV file itself is here.
  This file is valid for Sitecore 10.1 – if you need a different version, you will have to prepare and use a different CSV file (Read the article to learn more)

Steps to update each project in your solution:

• Step 1 – If your upgrade requires, update your Project to the target .NET Framework
• Step 2 – Get the NuGet commands to update your project.
• Step 3 – Run the NuGet commands at the Package Manager Console of Visual Studio

It is recommended to update the references gradually, so you can detect and fix any issue as you continue.

In my experience, the following sequence produced good results:

1. If your .NET Framework has changed due to the upgrade, re-install all references not used by Sitecore by running the following command:
   

   .\Update-PackagesFile.ps1 -Csv “C:\temp\NuGet Sitecore.Platform.Assemblies 10.1.0 rev. 005207.csv” -Packages “D:\Git\myproject\packages.config” -ProjectName “MyProject” -DumpUnknownReinstall $true

2. Update the 3rd party references to the target versions, and using this command:
   

   .\Update-PackagesFile.ps1 -Csv “C:\temp\NuGet Sitecore.Platform.Assemblies 10.1.0 rev. 005207.csv” -Packages “D:\Git\myproject\packages.config” -ProjectName “MyProject” -DumpKnownReinstall $true

3. Sometimes 3rd party reference versions didn’t change, but you still want to force them to reinstall.  If that’s your case, use the command:
   

   .\Update-PackagesFile.ps1 -Csv “C:\temp\NuGet Sitecore.Platform.Assemblies 10.1.0 rev. 005207.csv” -Packages “D:\Git\myproject\packages.config” -ProjectName “MyProject” -DumpKnownReinstall $true

4. Finally, uninstall and re-install your Sitecore references (useful when migrating from earlier versions into SC10):
   

   .\Update-PackagesFile.ps1 -Csv “C:\temp\NuGet Sitecore.Platform.Assemblies 10.1.0 rev. 005207.csv” -Packages “D:\Git\myproject\packages.config” -ProjectName “MyProject” -TargetSitecore “10.1” -DumpSitecoreUpdates $true

   or simply update them with this command:

   .\Update-PackagesFile.ps1 -Csv “C:\temp\NuGet Sitecore.Platform.Assemblies 10.1.0 rev. 005207.csv” -Packages “D:\Git\myproject\packages.config” -ProjectName “MyProject” -TargetSitecore “10.1” -DumpSitecoreUpdates $true -KeepSitecoreLibs $true

 

Full description of parameters:

• Csv (mandatory) – Path to the CSV file
• Packages (mandatory) – Path to the packages.config file
• ProjectName (mandatory) – Project Name
• TargetSitecore – Target Sitecore version
• DumpUnknownReinstall – If $true => Will dump the Update-Package with -reinstall commands for libraries not used by Sitecore
• DumpKnownUpdates – If $true => Will dump the Update-Package commands for known libraries when versions doesn’t match
• DumpKnownReinstall – If $true => Will dump the Update-Package with -reinstall when versions are the same
• DumpSitecoreUpdates – If $true => Will dump the Update-Package for Sitecore.* libraries
• KeepSitecoreLibs
  • If $true  => then the Sitecore entries will NOT be uninstalled (Update)
  • If $false => then the Sitecore entries will be uninstalled and re-installed (useful when migrating from earlier versions into SC10)

Categories: Powershell, Upgrades