Skip to main content

Package Validation

I recently discovered a .NET feature I didn’t know it existed; Package validation. Package validation was introduced as a part of the .NET 6 SDK. It allows you as a package author to check if your NuGet packages are consistent and well formed. At the moment of writing this post, the tooling provides the following checks:

  • Validates that there are no breaking changes across versions.
  • Validates that the package has the same set of publics APIs for all the different runtime-specific implementations.
  • Helps developers catch any applicability holes.

Enabling package validation is nothing more than setting the EnablePackageValidation property to true in your csproj file:

Now 3 different validators can kick in everytime you run dotnet pack:

  • The Baseline version validator validates your library project against a previously released, stable version of your package.
  • The Compatible runtime validator validates that your runtime-specific implementation assemblies are compatible with each other and with the compile-time assemblies.
  • The Compatible framework validator validates that code compiled against one framework can run against all the others in a multi-targeting package.

I’m interested in the Baseline version validator so let us focus on that one in this post.

The baseline validator allows you to validate your library project against a previously released, stable version of your package. It will detect any breaking change.

Before you can use the baseline validator, you first need to specify the baseline package that should be used as a comparison.

NuGet hosted packages

If your package is hosted on NuGet you can use the PackageValidationBaselineVersion property.Set it to a previous version you want to compare to. For example:

If I now run dotnet pack, I get an error message:

In this example it is because in the deployed package I have set both the AssemblyVersion and PackageVersion and in the local version I have only  set the PackageVersion.

But you also get errors when you do a breaking change. For example, I added an extra parameter to a public function. This results in the following error message:

Other package sources

If your package is not hosted on NuGet, you can still use the Baseline version validator but you should use the PackageValidationBaselinePath property and point it to the file location of your baseline NuGet package:

Labels:

Popular posts from this blog

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
Read more

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

VS Code Planning mode

After the introduction of Plan mode in Visual Studio , it now also found its way into VS Code. Planning mode, or as I like to call it 'Hannibal mode', extends GitHub Copilot's Agent Mode capabilities to handle larger, multi-step coding tasks with a structured approach. Instead of jumping straight into code generation, Planning mode creates a detailed execution plan. If you want more details, have a look at my previous post . Putting plan mode into action VS Code takes a different approach compared to Visual Studio when using plan mode. Instead of a configuration setting that you can activate but have limited control over, planning is available as a separate chat mode/agent: I like this approach better than how Visual Studio does it as you have explicit control when plan mode is activated. Instead of immediately diving into execution, the plan agent creates a plan and asks some follow up questions: You can further edit the plan by clicking on ‘Open in Editor’: ...
Read more