Neovolve.CodeAnalysis.ChangeTracking 3.0.0

.NET 5.0 .NET Standard 2.1
dotnet add package Neovolve.CodeAnalysis.ChangeTracking --version 3.0.0
NuGet\Install-Package Neovolve.CodeAnalysis.ChangeTracking -Version 3.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Neovolve.CodeAnalysis.ChangeTracking" Version="3.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Neovolve.CodeAnalysis.ChangeTracking --version 3.0.0
#r "nuget: Neovolve.CodeAnalysis.ChangeTracking, 3.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Neovolve.CodeAnalysis.ChangeTracking as a Cake Addin
#addin nuget:?package=Neovolve.CodeAnalysis.ChangeTracking&version=3.0.0

// Install Neovolve.CodeAnalysis.ChangeTracking as a Cake Tool
#tool nuget:?package=Neovolve.CodeAnalysis.ChangeTracking&version=3.0.0


C# code analysis tool for evaluating changes to contracts

GitHub license Nuget Nuget Actions Status


Neovolve.CodeAnalysis.ChangeTracking is a package that calculates changes between two versions of C# code to identify what has changed in regard to Semantic Versioning. The outcome will be an overall Semantic Version change result (None, Feature, Breaking) as well as a collection of changes. Each change in the collection identifies the source and target change along with a message indicating the change and the SemVer impact of that change.


Production and beta versions are available on NuGet.

Install-Package Neovolve.CodeAnalysis.ChangeTracking

Continous Integration builds are available on MyGet.

Install-Package Neovolve.CodeAnalysis.ChangeTracking -Source


This library will determine whether C# code has changed in a way that introduces a new feature or a breaking change.

Changes are evaluated for:

  • Classes
  • Interfaces
  • Structs
  • Properties
  • Fields
  • Methods
  • Attributes

The types of changes evaluated are:

  • Items removed
  • Items added
  • Items renamed
  • Changes to namespace (moved types, renamed namespace)
  • Changes of types
  • Changes to access modifiers
  • Changes to modifiers
  • Changes to generic type parameters
  • Changes to generic type constraints

Changes not currently evaluated are:

  • net5.0 record types
  • net5.0 init properties


var oldCode = new List<CodeSource>
    new CodeSource(@"
        public class Test
            public string Value;
        }", "Test.cs")
var newCode = new List<CodeSource>
    new CodeSource(@"
        public class Test
            public bool Value;
        }", "Test.cs")

var calculator = ChangeCalculatorFactory.BuildCalculator();

var result = await calculator.CalculateChange(oldCode, newCode).ConfigureAwait(false);

if (result.ChangeType == ChangeType.None) 
    // Looks like there is no change in the members
else if (result.ChangeType == ChangeType.Feature)
    // Looks like members have been added to the code
else if (result.ChangeType == ChangeType.Breaking)
    // Looks like members have been removed or changed


The library evaluates code changes by parsing the code text. The advantage of this method is that the code does not need to be compiled, dependencies do not need to be resolved and any C# project usage is supported. In fact the csproj itself is not even supported as the library only parses cs files. The disadvantage is that evaluating code changes can produce false positivies because all differences are evaluated as string values.

For example, the following two code blocks when evaluated will indicate a breaking change. In reality, it is likely that the code will compile to the same outcome.

public MyNamespace
    public class MyClass
        public System.DateTime MyValue { get; set; }
using System;

public MyNamespace
    public class MyClass
        public DateTime MyValue { get; set; }

Frequently asked questions

Why does SemVerChangeType define None instead of Patch?

This package attempts to calculate the Semantic Version impact on a C# binary based on changes to the public API surface (see attribute comparison below). Adding new signatures would be calculated as a feature and removing or modifying signatures would result in a breaking change.

There are only two other scenarios that could occur between two sets of C# code. There is either no change or there is a change to internal logic where there is no impact on the public API surface. No change should not even be identified as a patch change while changes to internal logic should be a patch change. As the library does not look at internal code, it can't actually determine the difference between these two scenarios so it does not attempt to identify a patch change as this may be misleading.

Why do attribute changes identify a feature or breaking change when the public API signature hasn't changed?

There is an edge case to the idea that the library only compares the public API surface between two versions of C# code. The library also evaluates changes to attributes based on the ComparerOptions class in order to determine a Semantic Version impact of attributes.

What this means is that the C# signatures could be the same, but attribute changes regarding XML and JSON serialization could cause a potential breaking change to consumers of the library. So signatures compiled into the binary are the same, but the attributes are telling the runtime to handle serialization differently.

For example, consider this change. Here is the old code.

using System;

public MyNamespace
    public class MyClass
        public DateTime MyValue { get; set; }

Here is the new code.

using System;
using System.Text.Json.Serialization;

public MyNamespace
    public class MyClass
        public DateTime MyValue { get; set; }

This is a breaking change to consumers because the json serialization of this class has changed the name of the property from MyValue to otherValue.


Combinations of data sets (combinations of access modifiers for example) were calculated using

This project is supported by JetBrains

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.0 558 11/6/2021
3.0.0-beta0020 198 10/4/2021
3.0.0-beta0014 211 10/3/2021
3.0.0-beta0009 175 9/18/2021
3.0.0-beta0005 242 9/12/2021
3.0.0-beta0002 249 9/12/2021
2.0.1 247 8/29/2021
2.0.1-beta0001 150 8/29/2021
2.0.0 270 8/29/2021
2.0.0-beta0325 191 8/29/2021
2.0.0-beta0288 185 7/31/2021
2.0.0-beta0252 158 4/26/2021
2.0.0-beta0217 147 4/25/2021
2.0.0-beta0183 164 4/25/2021
2.0.0-beta0150 165 4/21/2021
2.0.0-beta0118 184 4/18/2021
2.0.0-beta0087 181 4/17/2021
2.0.0-beta0057 137 4/13/2021
2.0.0-beta0028 163 2/7/2021
1.1.0-beta0123 215 11/23/2020
1.1.0-beta0101 229 11/23/2020
1.1.0-beta0080 233 11/23/2020
1.1.0-beta0060 227 11/23/2020
1.1.0-beta0041 267 11/22/2020
1.1.0-beta0023 210 11/13/2020
1.1.0-beta0022 233 11/12/2020
1.1.0-beta0021 239 11/12/2020
1.1.0-beta0020 239 11/10/2020
1.1.0-beta0019 270 10/14/2020
1.1.0-beta0018 277 10/14/2020
1.1.0-beta0017 233 10/9/2020
1.1.0-beta0016 284 10/3/2020
1.1.0-beta0015 312 9/27/2020
1.1.0-beta0014 254 9/15/2020
1.1.0-beta0013 239 9/9/2020
1.1.0-beta0012 231 9/9/2020
1.1.0-beta0011 236 9/2/2020
1.1.0-beta0010 224 8/21/2020
1.1.0-beta0006 300 8/12/2020
1.1.0-beta0003 250 8/12/2020
1.1.0-beta0001 295 8/9/2020
1.0.0 395 8/8/2020
0.1.0-beta0104 277 7/14/2020
0.1.0-beta0096 285 8/8/2020
0.1.0-beta0084 285 6/2/2020
0.1.0-beta0069 287 7/20/2020
0.1.0-beta0068 293 7/20/2020
0.1.0-beta0065 286 5/25/2020
0.1.0-beta0063 278 8/8/2020
0.1.0-beta0054 270 8/5/2020
0.1.0-beta0053 235 8/5/2020
0.1.0-beta0047 292 5/22/2020
0.1.0-beta0044 290 7/20/2020
0.1.0-beta0030 251 5/22/2020
0.1.0-beta0029 259 8/5/2020
0.1.0-beta0026 276 7/20/2020
0.1.0-beta0022 236 7/20/2020
0.1.0-beta0021 253 7/19/2020
0.1.0-beta0015 270 5/21/2020
0.1.0-beta0014 256 5/15/2020
0.1.0-beta0013 315 11/25/2019
0.1.0-beta0012 327 11/16/2019