Table of Contents

Current Version Static Badge

Upgrading from Git2SemVer.MSBuild V2 to V3

This page lists breaking changes in Git2SemVer.MSBuild 3.0.0 and recommended actions.

Breaking changes

TeamCity - build time statistic

Git2SemVer.MSBuild 3.0.0 has a breaking change that will impact users that are using versioning build time statistic on TeamCity (#43). The TeamCity versioning build time statistic was renamed from to Git2SemVerRunTime_sec to git2semver.runtime.seconds. If using a TeamCity build system and this build time statistic then the name will need to be manually changed in TeamCity.

Linux - libdl.so

Builds on Linux hosts (e.g: Ubuntu >= 22) may break with an error that the file libdl.so was not found. Git2SemVer.MSBuild 3.0.0 uses LibGit2Sharp to access Git history. LibGit2Sharp requires the libdl.so library file. Some manual configuration may be required on the build host to make this library avaiable as libdl.so.

For example, if a different version like libdl.so.2is available the a symlink to libdl.so may resolve the issue:

whereis libdl.so.2
libdl.so.2: /usr/lib/libdl.so.2 /usr/lib32/libdl.so.2
$ sudo ln -s /usr/lib/libdl.so.2 /usr/lib/libdl.so
$ sudo ln -s /usr/lib32/libdl.so.2 /usr/lib32/libdl.so

This release added some new optional build properties. To allow these properties to be used the versioning build target found in the NoeticTools.Git2SemVer.MSBuild.targets file needs lines added to pass the parameter into the versioning task.

To do this, in the targets file locate:

    <Git2SemVerGenerateVersionTask BuildNumber="$(Git2SemVer_BuildNumber)"
                                   BuildContext="$(Git2SemVer_BuildContext)"
                                   BuildIdFormat="$(Git2SemVer_BuildIDFormat)"
                                   Version="$(Version)"
                                   UpdateHostBuildLabel="$(Git2SemVer_UpdateHostBuildLabel)"
                                   ScriptArgs="$(Git2SemVer_ScriptArgs)"
                                   HostType="$(Git2SemVer_HostType)"
                                   BuildScriptPath="$(Git2SemVer_ScriptPath)"
                                   BranchMaturityPattern="$(Git2SemVer_BranchMaturityPattern)"
                                   WorkingDirectory="$(MSBuildProjectDirectory)"
                                   SolutionSharedDirectory="$(Git2SemVer_ShareDirectory)"
                                   SolutionSharedVersioningPropsFile="$(Git2SemVer_SharedVersioningJsonFile)"
                                   IntermediateOutputDirectory="$(Git2SemVer_IntermediateOutputPath)">

            :

    </Git2SemVerGenerateVersionTask>

Add the lines marked '+' below:

    <Git2SemVerGenerateVersionTask BuildNumber="$(Git2SemVer_BuildNumber)"
                                   BuildContext="$(Git2SemVer_BuildContext)"
                                   BuildIdFormat="$(Git2SemVer_BuildIDFormat)"
                                   Version="$(Version)"
                                   UpdateHostBuildLabel="$(Git2SemVer_UpdateHostBuildLabel)"
                                   ScriptArgs="$(Git2SemVer_ScriptArgs)"
                                   HostType="$(Git2SemVer_HostType)"
                                   BuildScriptPath="$(Git2SemVer_ScriptPath)"
                                   BranchMaturityPattern="$(Git2SemVer_BranchMaturityPattern)"
                                   WorkingDirectory="$(MSBuildProjectDirectory)"
                                   SolutionSharedDirectory="$(Git2SemVer_ShareDirectory)"
                                   SolutionSharedVersioningPropsFile="$(Git2SemVer_SharedVersioningJsonFile)"
                                   IntermediateOutputDirectory="$(Git2SemVer_IntermediateOutputPath)"
+                                   SourceLinkAppendingSha="$(IncludeSourceRevisionInInformationalVersion)"
+                                   Mode="$(Git2SemVer_Mode)"
+                                   RunScript="$(Git2SemVer_RunScript)"
+                                   ReleaseTagFormat="$(Git2SemVer_ReleaseTagFormat)">

            :

    </Git2SemVerGenerateVersionTask>
Edit this page