[Java.Interop] $(Version) depends on TargetFramework (#952)

Context: 2d5431f
Context: 88d6093
Context: #936
Context: https://github.com/jonpryor/java.interop/commits/jonp-registration-scope

Versioning is hard.

Way back in 3e6a623 we tried to use the `GitInfo` NuGet package so
that *all* assemblies would have a version number which contained the
number of commits since `GitInfo.txt` changed.

This turned out to have unanticipated breakage, and was largely
reverted in 2d5431f for "core" libs like `Java.Interop.dll`, but
retained for "utility" apps and libs like `generator.exe`.

This still presents a problem, though: the *point* to assembly
versioning is to prevent accidental breaking of referencing
assemblies.  If we add a new member to `Java.Interop.dll` but
*fail to update the version*, then that *permits* a scenario in which
an app/lib depends on the new member, but is built against a version
missing that member.  This results in runtime exceptions.

The whole reason this hasn't been a problem so far is because
`Java.Interop.dll` has barely changed in *years*.  (Plus, most usage
is hidden behind other layers and libs…)

However, *I want this to change*: #936 and
jonpryor/java.interop/jonp-registration-scope both *add* new public
API to `Java.Interop.dll`, and there are other features and
optimizations we're considering that would also require API changes.
A policy of "no changes" isn't tenable.

Thus: allow `Java.Interop.dll` built for .NET 6 to have a different
`$(Version)` than the one built for .NET Standard 2.0.

Fixing this was unexpectedly problematic, as commit 88d6093:

>  Update[d] `Java.Interop.BootstrapTasks.csproj` to *no longer*
> `<Import/>` `VersionInfo.targets`, as this causes a circular
> dependency (`VersionInfo.targets` uses tasks from
> `Java.Interop.BootstrapTasks.dll`).  This is fine, as
> `Java.Interop.BootstrapTasks.dll` doesn't need to be versioned.

`Java.Interop.BootstrapTasks.dll` doesn't need to be versioned, but
*other assemblies **do***, and this change change meant that
`VersionInfo.targets` was *never* used, which in turn meant that e.g.
`bin/BuildDebug/Version.props` was never created.

This change *also* implicitly reverted all remaining 3e6a623
behavior; in commit 13def0e (one prior to 88d6093), `generator.exe`
*had* a version of 0.1.45.0.  Starting with commit 88d6093,
`generator.exe` had version 1.0.0.0, which re-introduces the
"baseline" scenario which first necessitated 3e6a623!

Re-think this process, while avoiding the circular dependency:

 1. `Java.Interop.BootstrapTasks.targets` now *generates* a
    `Version.props` file, re-introducing its existence.
    `Version.props` now contains *four* version values:

      * `$(JINetToolVersion)`: Version to use for "utility"
        assemblies which target .NET.

      * `$(JINetCoreLibVersion)`: Version to use for "core library"
        assemblies which target .NET.

      * `$(JIOldToolVersion)`: Version to use for "utility"
        assemblies which target .NET Standard/Framework/etc.

      * `$(JIOldCoreLibVersion)`: Version to use for "core library"
        assemblies which target .NET Standard/Framework/etc.

    The `$(JINet*)` values derive their major, minor, and patch
    values from `GitInfo`, while the `$(JIOld*)` values are
    backward compatible (-ish).

 2. Update/replace `VersionInfo.targets` with a
    `_SetInformationalVersion` target, which sets the
    `$(InformationalVersion)` MSBuild property based on the value
    of `$(Version)` and various other properties.

 3. `Directory.Build.props` is updated to provide new
    `$(JIUtilityVersion)` and `$(JICoreLibVersion)` properties, which
    are set based on the `$(TargetFramework)` value.

 4. Set the default `$(Version)` value to `$(JIUtilityVersion)`.
    "Core library" assemblies must explicitly set `$(Version)` in
    their `.csproj` to instead be `$(JICoreLibVersion)`.

The result is that for "core libraries" such as `Java.Interop.dll`,
when building for .NET Standard or MonoAndroid they will continue to
use version 0.1.0.0 (see also 2d5431f), while these assemblies will
use version 6.0.0.0 when built for .NET Core/6.

"Utility" assemblies such as `generator.exe` will contain a version
number which changes based on when `GitInfo.txt` was last changed.
When building for .NET Standard, they will use version
`0.2.$(GitBaseVersionPatch).$(GitCommits)`, which differs from the
pre-88d6093c pattern of `0.1.$(GitSemVerPatch).0`, but as my current
system Xamarin.Android v12.1.99.117 install shows that `generator.exe`
has version 0.1.31.0, "rebasing" on 0.2.x feels easiest.
When utility assemblies are built for .NET, they will instead use the
values from `GitInfo.txt`, e.g. `6.0.0.$(GitCommits)`.

Finally, *always* set `$(FileVersion)` to:

	$(GitBaseVersionMajor).$(GitBaseVersionMinor).$(GitBaseVersionPatch).$(GitCommits)

[`$(FileVersion)`][0] is used to set
[`$(AssemblyFileVersionAttribute)`][1], which is *not* used for
assembly binding, but *is* shown in the Windows File Properties
dialog, and can be used to (indirectly) determine which commit an
assembly was built from.

[0]: https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props
[1]: https://docs.microsoft.com/en-us/dotnet/api/system.reflection.assemblyfileversionattribute?view=net-6.0

Author: jonpryor

Directory.Build.props

@@ -62,13 +62,17 @@
     <UtilityOutputFullPath Condition=" '$(UtilityOutputFullPathCoreApps)' != '' ">$(UtilityOutputFullPathCoreApps)</UtilityOutputFullPath>
     <UtilityOutputFullPath Condition=" '$(UtilityOutputFullPathCoreApps)' == '' ">$(ToolOutputFullPath)</UtilityOutputFullPath>
     <RollForward>Major</RollForward>
+    <JIUtilityVersion>$(JINetToolVersion)</JIUtilityVersion>
+    <JICoreLibVersion>$(JINetCoreLibVersion)</JICoreLibVersion>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(JIBuildingForNetCoreApp)' != 'True' ">
     <IntermediateOutputPath>$(BaseIntermediateOutputPath)\$(Configuration)</IntermediateOutputPath>
     <BuildToolOutputFullPath>$(MSBuildThisFileDirectory)bin\Build$(Configuration)\</BuildToolOutputFullPath>
     <ToolOutputFullPath>$(MSBuildThisFileDirectory)bin\$(Configuration)\</ToolOutputFullPath>
     <TestOutputFullPath>$(MSBuildThisFileDirectory)bin\Test$(Configuration)\</TestOutputFullPath>
     <UtilityOutputFullPath Condition=" '$(UtilityOutputFullPath)' == '' ">$(ToolOutputFullPath)</UtilityOutputFullPath>
+    <JIUtilityVersion>$(JIOldToolVersion)</JIUtilityVersion>
+    <JICoreLibVersion>$(JIOldCoreLibVersion)</JICoreLibVersion>
   </PropertyGroup>
   <PropertyGroup>
     <XamarinAndroidToolsDirectory   Condition=" '$(XamarinAndroidToolsDirectory)' == '' ">$(MSBuildThisFileDirectory)external\xamarin-android-tools</XamarinAndroidToolsDirectory>
@@ -119,4 +123,8 @@
     <NoWarn>$(NoWarn);CA1307;CA1309;CA1310</NoWarn>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <Version>$(JIUtilityVersion)</Version>
+  </PropertyGroup>
+
 </Project>

Directory.Build.targets

@@ -34,4 +34,6 @@
     <PackageReference Update="XliffTasks"                                   Version="1.0.0-beta.20420.1" />
   </ItemGroup>
 
+  <Import Project="build-tools\scripts\VersionInfo.targets" />
+
 </Project>

GitInfo.txt

@@ -1 +1 @@
-0.1
+6.0

build-tools/Java.Interop.BootstrapTasks/Java.Interop.BootstrapTasks.csproj

@@ -6,7 +6,13 @@
     <OutputPath>$(BuildToolOutputFullPath)</OutputPath>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <GitDefaultBranch>main</GitDefaultBranch>
+    <GitThisAssembly>false</GitThisAssembly>
+  </PropertyGroup>
+
   <ItemGroup>
+    <PackageReference Include="GitInfo" />
     <PackageReference Include="Microsoft.Build.Framework" />
     <PackageReference Include="Microsoft.Build.Utilities.Core" />
     <PackageReference Include="NUnit.ConsoleRunner" GeneratePathProperty="True" />

build-tools/Java.Interop.BootstrapTasks/Java.Interop.BootstrapTasks.targets

@@ -105,4 +105,37 @@
     <Touch Files="$(_OutputPath)PackagePaths.props" />
   </Target>
 
+ <Target Name="_CreateVersionProps"
+      AfterTargets="Build"
+      DependsOnTargets="GitVersion"
+      Inputs="$(MSBuildThisFileFullPath);$(MSBuildThisFileDirectory)Java.Interop.BootstrapTasks.csproj"
+      Outputs="$(_OutputPath)Versions.props">
+    <PropertyGroup>
+      <_NetToolVersion>$(GitBaseVersionMajor).$(GitBaseVersionMinor).$(GitBaseVersionPatch).$(GitCommits)</_NetToolVersion>
+      <_OldToolVersion>0.2.$(GitBaseVersionPatch).$(GitCommits)</_OldToolVersion>
+      <_NetCoreLibVersion>$(GitBaseVersionMajor).$(GitBaseVersionMinor).0.0</_NetCoreLibVersion>
+      <_OldCoreLibVersion>0.1.0.0</_OldCoreLibVersion>
+      <_FileVersion>$(GitBaseVersionMajor).$(GitBaseVersionMinor).$(GitBaseVersionPatch).$(GitCommits)</_FileVersion>
+    </PropertyGroup>
+    <ItemGroup>
+      <_VersionsLine Include="&lt;Project&gt;" />
+      <_VersionsLine Include="  &lt;PropertyGroup&gt;" />
+      <_VersionsLine Include="    &lt;FileVersion&gt;$(_FileVersion)&lt;/FileVersion&gt;" />
+      <_VersionsLine Include="    &lt;JINetToolVersion&gt;$(_NetToolVersion)&lt;/JINetToolVersion&gt;" />
+      <_VersionsLine Include="    &lt;JIOldToolVersion&gt;$(_OldToolVersion)&lt;/JIOldToolVersion&gt;" />
+      <_VersionsLine Include="    &lt;JINetCoreLibVersion&gt;$(_NetCoreLibVersion)&lt;/JINetCoreLibVersion&gt;" />
+      <_VersionsLine Include="    &lt;JIOldCoreLibVersion&gt;$(_OldCoreLibVersion)&lt;/JIOldCoreLibVersion&gt;" />
+      <_VersionsLine Include="    &lt;JIBuildBranch&gt;$(GitBranch)&lt;/JIBuildBranch&gt;" />
+      <_VersionsLine Include="    &lt;JIBuildCommit&gt;$(GitCommit)&lt;/JIBuildCommit&gt;" />
+      <_VersionsLine Include="  &lt;/PropertyGroup&gt;" />
+      <_VersionsLine Include="&lt;/Project&gt;" />
+    </ItemGroup>
+    <WriteLinesToFile
+        File="$(_OutputPath)Version.props"
+        Lines="@(_VersionsLine)"
+        Overwrite="True"
+    />
+    <Touch Files="$(_OutputPath)Version.props" />
+  </Target>
+
 </Project>

build-tools/scripts/Version.props.in

@@ -1,29 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
-<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+<Project>
 
-  <UsingTask AssemblyFile="$(MSBuildThisFileDirectory)..\..\bin\Build$(Configuration)\Java.Interop.BootstrapTasks.dll"
-      TaskName="Java.Interop.BootstrapTasks.ReplaceFileContents" />
-  <PropertyGroup>
-    <GitDefaultBranch>main</GitDefaultBranch>
-    <GitThisAssembly>false</GitThisAssembly>
-  </PropertyGroup>
-  <ItemGroup>
-    <PackageReference Include="GitInfo" PrivateAssets="all" />
-  </ItemGroup>
-
-  <Target Name="GenerateVersionInfo"
-      AfterTargets="Build"
-      DependsOnTargets="GitVersion"
-      Condition="!Exists ('$(MSBuildThisFileDirectory)..\..\bin\Build$(Configuration)\Version.props')">
-    <ItemGroup>
-      <Replacements Include="@VERSION@" Replacement="$(GitSemVerMajor).$(GitSemVerMinor).$(GitSemVerPatch).0"/>
-      <Replacements Include="@COMMIT@" Replacement="$(GitCommit)"/>
-      <Replacements Include="@BRANCH@" Replacement="$(GitBranch)"/>
-    </ItemGroup>
-    <ReplaceFileContents
-        TemplateFile="$(MSBuildThisFileDirectory)Version.props.in"
-        OutputFile="$(MSBuildThisFileDirectory)..\..\bin\Build$(Configuration)\Version.props"
-        Replacements="@(Replacements)"
-    />
+  <Target Name="_SetInformationalVersion"
+      BeforeTargets="GetAssemblyVersion;GetPackageVersion">
+    <PropertyGroup>
+      <InformationalVersion>$(Version) git-rev-head:$(JIBuildCommit) git-branch:$(JIBuildBranch)</InformationalVersion>
+    </PropertyGroup>
   </Target>
+
 </Project>

build-tools/scripts/VersionInfo.targets

@@ -5,6 +5,7 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <Nullable>enable</Nullable>
     <NoWarn>$(NoWarn);8764</NoWarn>
+    <Version>$(JICoreLibVersion)</Version>
   </PropertyGroup>
 
   <ItemGroup>

src/Java.Base/Java.Base.csproj

@@ -7,7 +7,7 @@
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\..\product.snk</AssemblyOriginatorKeyFile>
     <AssemblyTitle>Java.Interop.Dynamic</AssemblyTitle>
-    <Version>0.1.0.0</Version>
+    <Version>$(JICoreLibVersion)</Version>
   </PropertyGroup>
   <PropertyGroup>
     <OutputPath>$(ToolOutputFullPath)</OutputPath>

src/Java.Interop.Dynamic/Java.Interop.Dynamic.csproj

@@ -7,7 +7,7 @@
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\..\product.snk</AssemblyOriginatorKeyFile>
     <AssemblyTitle>Java.Interop.Export</AssemblyTitle>
-    <Version>0.1.0.0</Version>
+    <Version>$(JICoreLibVersion)</Version>
   </PropertyGroup>
   <PropertyGroup>
     <OutputPath>$(ToolOutputFullPath)</OutputPath>