Introduction

Update vs Upgrade (Migration)

To avoid confusion, let's start by defining Update and Upgrade (Migration) which have completely different meanings.

When we say Update it generally means Updating Serenity NuGet Packages to their latest versions. This is just about fetching latest versions of binary NuGet packages and most of the time that does not require any manual code modification.

Meanwhile, upgrade (or migration) involves breaking changes and there will be some modifications that needs to be applied to your code manually.

Migration is sometimes confused with Database Migration so we refer to it as a upgrade.

If you update Serenity packages and see that something does not work as it should, you should visit Migrations section on this site to understand what to do. It is also a good idea to visit this site before trying a update to see if there are any breaking changes.

Premium StartSharp customers can use stargen tool to automate updates and upgrades if any.

Updating/Upgrading Using Stargen

Identifying Packages to Update

To see which Serenity packages you need to update, first have a look at your csproj file:

<PackageReference Include="Serenity.Pro.Scripts" Version="5.0.12" />
<PackageReference Include="Serenity.Net.Web" Version="5.0.20" />
<PackageReference Include="Serenity.Assets" Version="5.0.19" />
<PackageReference Include="Serenity.Scripts" Version="5.0.20" />
<PackageReference Include="Serenity.Demo.ThemeSamples" Version="5.0.20.1" />

Take a note of any PackageReference include that starts with Serenity.

Updating Serenity Packages

Updating Serenity packages only updates Serenity NuGet Packages to their most recent versions.

Open a command prompt at your project directory and execute following commands in order:

Base Package Updates

dotnet restore
dotnet add package Serenity.Net.Web
dotnet add package Serenity.Assets
dotnet add package Serenity.Scripts

If you use Package Manager Console in Visual Studio you may also try Update-Package command instead of dotnet add package.

Pro (Premium) Package Updates

If you are a StartSharp customer, please make sure you have serenity.is package source configured and execute following for only the packages you actually use:

Please follow directions at https://serenity.is/Dashboard if you don't have serenity.is premium package source configured.

# these are fundamental packages thare usually referenced
dotnet add package Serenity.Pro.Extensions
dotnet add package Serenity.Pro.Theme
dotnet add package Serenity.Pro.UI

Not all pro packages might be listed above. Please check your project file for references starting with Serenity.Pro.

Updating Feature Packages

If you have common / premium feature packages like Serenity.Demo.ThemeSamples etc in your project, you'll need to also update them (otherwise you shouldn't):

dotnet add package Serenity.Demo.ThemeSamples
dotnet add package Serenity.Demo.Northwind
dotnet add package Serenity.Demo.BasicSamples

# the ones below are premium ones
dotnet add package Serenity.Demo.AdvancedSamples
dotnet add package Serenity.Pro.DataAuditLog
dotnet add package Serenity.Pro.DataExplorer
dotnet add package Serenity.Pro.EmailClient
dotnet add package Serenity.Pro.EmailQueue
dotnet add package Serenity.Pro.Meeting
dotnet add package Serenity.Pro.Organization
dotnet add package Serenity.Pro.WorkLog

Updating Sergen (Serenity Code Generator)

Sergen is a dotnet tool developed for Serenity applications, and is used to generate new entities / services / pages.

It is also integrated with the build process to perform some transformations and share types between TypeScript and C# code (by generating code on build).

You should always keep sergen up-to-date with Serenity version (e.g. their versions should match). Otherwise, as the code generated by an older version might not be compatible with a recent Serenity version, it may result in compile / runtime errors.

Run the following command to update sergen tool:

dotnet tool update sergen

Copying Content to wwwroot with `dotnet sergen restore`

This part is critical and is usually ignored or forgotten by some users leading to runtime script errors.

Normally .NET Core NuGet packages can no longer have content like scripts, css and have them copied to project itself e.g. to wwwroot folder in ASP.NET Core projects.

We implemented a workaround for that limitation by using sergen. Everytime you update Serenity packages you should run the following command:

dotnet sergen restore

Otherwise you might still be using old versions of Serenity and other third party scripts / css files.

Most of our premium packages uses Razor class library / static web assets feature now, and the situation explained above should not apply to them.

This also restores (or updates) TypeScript .d.ts to your typings directory from Serenity packages.

Applying Upgrades (Migration)

If you tried to update and had some issues, you should check the migration notes that are listed on the left navigation.

It is also a good idea to check them even when no errors occur during the update. There might be some critical security issues etc. that should be handled.

You should start from the version you created your project from, and apply all of the migrations in order (from bottom to top).

For example, if you created your project from a v3.14.x template, and the latest version is 5.0.20, you should apply upgrade notes in following order:

3.14.x to 5.0.12
5.0.12 to 5.0.20

StartSharp customers should see the following document and use Stargen tool to automate the update / upgrade process:

Upgrading / Updating using Stargen

Stargen automates all updates listed here in addition to upgrades. In a feature version it will also be able to convert a Serene project to StartSharp one by adding missing features.