Oleander.Assembly.Versioning.BuildTask 1.3.0

dotnet add package Oleander.Assembly.Versioning.BuildTask --version 1.3.0                
NuGet\Install-Package Oleander.Assembly.Versioning.BuildTask -Version 1.3.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="Oleander.Assembly.Versioning.BuildTask" Version="1.3.0">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Oleander.Assembly.Versioning.BuildTask --version 1.3.0                
#r "nuget: Oleander.Assembly.Versioning.BuildTask, 1.3.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 Oleander.Assembly.Versioning.BuildTask as a Cake Addin
#addin nuget:?package=Oleander.Assembly.Versioning.BuildTask&version=1.3.0

// Install Oleander.Assembly.Versioning.BuildTask as a Cake Tool
#tool nuget:?package=Oleander.Assembly.Versioning.BuildTask&version=1.3.0                

AssemblyVersioning

Assembly versioning is a tool that calculates the next version of a dotnet assembly. To do this, the public API of the assembly is compared with the last (reference version) compiled version.

Oleander.Assembly.Comparers

Based on Telerik's JustDecompile, the public API of two dotnet assemblies is compared.

Result:

  • VersionChange.None: no changes

  • VersionChange.Revision: not used here

  • VersionChange.Build: changes do not affect the public API

  • VersionChange.Minor: API has been changed but is backwards compatible

  • VersionChange.Major: The API has been changed and is not backwards compatible (BreakingChange)

  • ToXml(): Changes in XML format

Oleander.Assembly.Versioning

Includes the logic and infrastructure.

  • Tries to download the NuGet package with the highest version as a reference assembly

  • Updates the project or AssemblyInfo.cs file

    • AssemblyVersion: calculated version
    • FileVersion: calculated version
    • Version: calculated version + VersionSuffix
    • SourceRevisionId: git commit hash number
    • VersionSuffix: alpha, beta
  • Customizing

    • .gitdiff<br><br> File containing the file extensions whose build number should be increased. Each line corresponds to a file extension.

    • .versioningIgnore<br><br> File in the project or git repository directory with the API names that should be ignored when calculating the version.

Oleander.Assembly.Versioning.BuildTask

Microsoft.Build.Utilities.Task: Adds a target to MSBuild. To calculate the version for each build process, add the task to your project: dotnet add package Oleander.Assembly.Versioning.BuildTask --version {version}

Oleander.Assembly.Versioning.Tool

A dotnet tool for comparing dotnet assemblies and updating your project version.

dotnet tool install --global dotnet-oleander-versioning-tool

Release notes:

  • 1.2.0.0 The MSBuild variable $(MSBuildProjectName) is now supported when creating the PackageId.
  • 1.3.0.0 Warn if breaking change
There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

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
1.3.0 499 8/19/2024
1.2.0 177 7/31/2024
1.0.1.6 405 6/12/2024
1.0.1.1 716 3/25/2024
1.0.0 608 3/15/2024

Oleander.Assembly.Versioning.BuildTask Version:1.3.0.0 Release:240819