From 954760857d7b96c81a1e2df3cf7d70d6b6db7d69 Mon Sep 17 00:00:00 2001
From: papeh <hasso_pape@sil.org>
Date: Mon, 12 Dec 2022 10:10:49 -0600
Subject: [PATCH] Build Chorus Hub Installer with GHA (#314)

* Build Chorus Hub Installer with GitHub Actions
* Update a deprecated WiX attribute
* clean up (completes https://github.com/sillsdev/chorus/issues/299)
* check out help in a clean location
---
 .github/workflows/dotnet.yml        |  20 +++++-
 build/Chorus.proj                   |  96 ----------------------------
 src/Installer/ChorusHub.wixproj     |  46 +++++++------
 src/Installer/ChorusHub.wxs         |  11 ++--
 src/Installer/ChorusMergeModule.wxs |   2 +-
 src/Installer/resources/License.rtf | Bin 1541 -> 1546 bytes
 6 files changed, 48 insertions(+), 127 deletions(-)
 delete mode 100644 build/Chorus.proj

diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
index 68ee9743b..2e2f02c55 100644
--- a/.github/workflows/dotnet.yml
+++ b/.github/workflows/dotnet.yml
@@ -69,8 +69,7 @@ jobs:
       uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3.0.2
       with:
         repository: sillsdev/chorushelp
-        path: lib
-        clean: false # don't delete other files from lib
+        path: DistFiles/Help
       if: matrix.os == 'windows-latest'
 
     - name: Add msbuild to PATH
@@ -87,7 +86,7 @@ jobs:
       run: msbuild src/Installer/ChorusMergeModule.wixproj -t:pack
       if: matrix.os == 'windows-latest'
 
-    - name: Upload Merge Modules
+    - name: Upload Merge Module
       uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
       with:
         name: chorus-merge-module
@@ -96,6 +95,21 @@ jobs:
           output/*.nupkg
       if: matrix.os == 'windows-latest'
 
+    - name: Build Chorus Hub Installer
+      run: |
+        msbuild src/Installer/ChorusHub.wixproj /t:Restore
+        msbuild src/Installer/ChorusHub.wixproj /t:StampLicenseYear
+        msbuild src/Installer/ChorusHub.wixproj /t:Build
+      if: matrix.os == 'windows-latest'
+
+    - name: Upload Chorus Hub Installer
+      uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+      with:
+        name: chorus-hub-installer
+        path: |
+          output/Release/*.msi
+      if: matrix.os == 'windows-latest'
+
     - name: Pack
       run: dotnet pack --no-restore --no-build -c Release
 
diff --git a/build/Chorus.proj b/build/Chorus.proj
deleted file mode 100644
index 5e7cc9c26..000000000
--- a/build/Chorus.proj
+++ /dev/null
@@ -1,96 +0,0 @@
-<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003" DefaultTargets="Build;Pack">
-	<PropertyGroup>
-		<RootDir Condition="'$(teamcity_build_checkoutDir)' == '' And '$(RootDir)'==''">$(MSBuildProjectDirectory)/..</RootDir>
-		<RootDir Condition="'$(teamcity_build_checkoutDir)' != ''">$(teamcity_build_checkoutDir)</RootDir>
-		<Solution>Chorus.sln</Solution>
-		<SolutionPath>$(RootDir)/$(Solution)</SolutionPath>
-		<ApplicationName Condition="'$(OS)'=='Windows_NT'">ChorusLibrary</ApplicationName>
-		<ApplicationName Condition="'$(OS)'!='Windows_NT'">Chorus</ApplicationName>
-		<ApplicationNameLC>chorus</ApplicationNameLC>
-		<Configuration Condition="'$(Configuration)'==''">Release</Configuration>
-		<ExtraExcludeCategories Condition="'$(OS)'!='Windows_NT'">KnownMonoIssue,</ExtraExcludeCategories>
-		<ExtraExcludeCategories Condition="'$(teamcity_version)' != ''">SkipOnTeamCity,SkipOnBuildServer,SkipOnTeamCityRandomTestFailure,$(ExtraExcludeCategories)</ExtraExcludeCategories>
-		<useNUnit-x86 Condition="'$(OS)'=='Windows_NT'">true</useNUnit-x86>
-		<useNUnit-x86 Condition="'$(OS)'!='Windows_NT'">false</useNUnit-x86>
-		<OutputDir>$(RootDir)/output/$(Configuration)</OutputDir>
-		<TeamCity Condition="'$(teamcity_version)' != ''">true</TeamCity>
-		<TeamCity Condition="'$(teamcity_version)' == ''">false</TeamCity>
-
-		<RestartBuild Condition="!Exists('$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll') Or !Exists('$(RootDir)/packages/NUnit.ConsoleRunner/tools/nunit3-console.exe') Or !Exists('$(RootDir)/packages/BuildDependencyTasks/BuildDependencyTasks.dll')">true</RestartBuild>
-		<RestartBuild Condition="Exists('$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll') And Exists('$(RootDir)/packages/NUnit.ConsoleRunner/tools/nunit3-console.exe') And Exists('$(RootDir)/packages/BuildDependencyTasks/BuildDependencyTasks.dll')">false</RestartBuild>
-	</PropertyGroup>
-
-	<Import Project="NuGet.targets"/>
-
-	<Target Name="RestoreBuildTasks" DependsOnTargets="CheckPrerequisites">
-		<Message Text="RestartBuild=$(RestartBuild)" />
-		<Exec Command='$(NuGetCommand) install NUnit.Console -excludeVersion -version 3.11.1 -solutionDirectory "$(RootDir)"' />
-		<Exec Command='$(NuGetCommand) install SIL.BuildTasks -excludeVersion -version 2.3.2 -solutionDirectory "$(RootDir)"' />
-		<Exec Command='$(NuGetCommand) install BuildDependencyTasks -excludeVersion -version 0.4.3 -solutionDirectory "$(RootDir)"' />
-	</Target>
-
-	<UsingTask TaskName="MakeWixForDirTree" AssemblyFile="$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll"
-		Condition="'$(OS)'=='Windows_NT' And Exists('$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll')"/>
-	<UsingTask TaskName="Archive" AssemblyFile="$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll"
-		Condition="'$(OS)'!='Windows_NT' And Exists('$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll')"/>
-	<UsingTask TaskName="FileUpdate" AssemblyFile="$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll" Condition="Exists('$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll')"/>
-	<UsingTask TaskName="NUnit3" AssemblyFile="$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll" Condition="Exists('$(RootDir)/packages/SIL.BuildTasks/tools/SIL.BuildTasks.dll')"/>
-	<UsingTask TaskName="Dependencies" AssemblyFile="$(SolutionDir)/packages/BuildDependencyTasks/BuildDependencyTasks.dll" Condition="Exists('$(RootDir)/packages/BuildDependencyTasks/BuildDependencyTasks.dll')"/>
-
-	<!-- Windows installer stuff -->
-	<Target Name="Installer" DependsOnTargets="CleanInstaller; Build" Condition="'$(OS)'=='Windows_NT'">
-
-		<!-- set the version number in the installer configuration program.  Perhaps there's a way to just send in the variables rather than this brute-force
-		changing of the script, but I haven't figured that out. -->
-
-		<FileUpdate File="$(RootDir)\src\Installer\ChorusMergeModule.wxs" Regex='Property_ProductVersion = ".*"'
-				ReplacementText ="Property_ProductVersion = &quot;$(GitVersion_AssemblySemFileVer)&quot;" />
-		<Message Text="Making Chorus Merge Module Version: $(GitVersion_AssemblySemFileVer)" Importance="high"  />
-
-		<MSBuild Projects="$(RootDir)\src\Installer\ChorusMergeModule.wixproj"/>
-
-	</Target>
-
-	<Target Name="ChorusHubInstaller" DependsOnTargets="CleanInstaller;Build" Condition="'$(OS)'=='Windows_NT'">
-
-		<!-- set the version number in the installer configuration program.  Perhaps there's a way to just send in the variables rather than this brute-force
-		changing of the script, but I haven't figured that out. -->
-
-		<FileUpdate File="$(RootDir)\src\Installer\ChorusHub.wxs" Regex='Property_ProductVersion = ".*"'
-				ReplacementText="Property_ProductVersion = &quot;$(GitVersion_AssemblySemFileVer)&quot;" />
-		<FileUpdate File="$(RootDir)\src\Installer\resources\License.rtf" RegEx='COPYRIGHTYEARPLACEHOLDER'
-				ReplacementText="$([System.DateTime]::Now.ToString(yyyy))" />
-		<Message Text="Making Chorus Hub installer with version: $(GitVersion_AssemblySemFileVer)" Importance="high"  />
-
-		<MSBuild Projects="$(RootDir)\src\Installer\ChorusHub.wixproj"/>
-
-	</Target>
-
-	<Target Name="SignChorusHub" DependsOnTargets="ChorusHubInstaller">
-		<Message Text="Attempting to sign ChorusHubInstaller.msi" Importance="high" />
-		<Exec Command='sign "$(RootDir)\output\Release\ChorusHubInstaller.msi" ' />
-	</Target>
-
-	<Target Name="MakeWixForDistFiles" DependsOnTargets="Compile" Condition="'$(OS)'=='Windows_NT'">
-		<!-- NB: The Exclude argument doesn't seem to be working so you may need to hand edit the GeneratedMercurial.wxs -->
-		<MakeWixForDirTree
-			DirectoryReferenceId="mercurial"
-			ComponentGroupId="Mercurial"
-			RootDirectory="$(RootDir)\mercurial"
-			OutputFilePath="$(RootDir)\src\Installer\GeneratedMercurial.wxs"
-			IgnoreRegExPattern="IGNOREME|\.gitignore"
-			Exclude="$(RootDir)\mercurial\mercurial.ini;$(RootDir)\mercurial\default.d\cacerts.rc"
-			MatchRegExPattern=".*">
-			<Output TaskParameter="OutputFilePath" ItemName="Compile" />
-		</MakeWixForDirTree>
-		<MakeWixForDirTree
-			DirectoryReferenceId="MercurialExtensions"
-			ComponentGroupId="MercurialExtensions"
-			RootDirectory="$(RootDir)\MercurialExtensions"
-			OutputFilePath="$(RootDir)\src\Installer\GeneratedMercurialExtensions.wxs"
-			IgnoreRegExPattern="IGNOREME|\.gitignore"
-			MatchRegExPattern=".*">
-			<Output TaskParameter="OutputFilePath" ItemName="Compile" />
-		</MakeWixForDirTree>
-	</Target>
-</Project>
diff --git a/src/Installer/ChorusHub.wixproj b/src/Installer/ChorusHub.wixproj
index 27e92cb7c..64b4c63c0 100644
--- a/src/Installer/ChorusHub.wixproj
+++ b/src/Installer/ChorusHub.wixproj
@@ -1,26 +1,22 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!-- NB: rather than bothering with GitVersion here, we simply expect the version to be lingering in the environment from previous runs.
+	This is supported by .github/workflows/dotnet.yml -->
 <Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
 	<Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration>
 	<Platform Condition=" '$(Platform)' == '' ">x86</Platform>
-	<ProductVersion>3.5</ProductVersion>
+	<ProductVersion>$(GitVersion_AssemblySemVer)</ProductVersion>
 	<ProjectGuid>c1ee5822-e382-11de-8a39-0800200c9a66</ProjectGuid>
 	<SchemaVersion>2.0</SchemaVersion>
 	<OutputName>ChorusHubInstaller</OutputName>
 	<OutputType>Package</OutputType>
+	<OutputPath>..\..\output\$(Configuration)\</OutputPath>
 	<WixTargetsPath Condition=" '$(WixTargetsPath)' == '' AND '$(MSBuildExtensionsPath32)' != '' ">$(MSBuildExtensionsPath32)\Microsoft\WiX\v3.x\Wix.targets</WixTargetsPath>
 	<WixTargetsPath Condition=" '$(WixTargetsPath)' == '' ">$(MSBuildExtensionsPath)\Microsoft\WiX\v3.x\Wix.targets</WixTargetsPath>
 	<Name>ChorusHubInstaller</Name>
-  </PropertyGroup>
-  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
-	<OutputPath>..\..\output\Debug\</OutputPath>
-	<IntermediateOutputPath>obj\Debug\</IntermediateOutputPath>
-	<DefineConstants>Debug</DefineConstants>
-	<SuppressPdbOutput>True</SuppressPdbOutput>
-  </PropertyGroup>
-  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
-	<OutputPath>..\..\output\Release\</OutputPath>
-	<IntermediateOutputPath>obj\Release\</IntermediateOutputPath>
+	<DefineConstants>ProductVersion=$(ProductVersion)</DefineConstants>
+	<DefineConstants Condition="'$(Configuration)' == 'Debug'">Debug;$(DefineConstants)</DefineConstants>
+	<DefineSolutionProperties>false</DefineSolutionProperties>
 	<SuppressPdbOutput>True</SuppressPdbOutput>
   </PropertyGroup>
   <ItemGroup>
@@ -47,12 +43,22 @@
 	</WixExtension>
   </ItemGroup>
   <Import Project="$(WixTargetsPath)" />
-  <!--
-	To modify your build process, add your task inside one of the targets below and uncomment it.
-	Other similar extension points exist, see Wix.targets.
-	<Target Name="BeforeBuild">
-	</Target>
-	<Target Name="AfterBuild">
-	</Target>
-	-->
-</Project>
\ No newline at end of file
+
+  <!-- Stamp Years -->
+  <Import Project="NuGet.targets" />
+  <PropertyGroup>
+	<SilBuildTasksVersion>2.5.0</SilBuildTasksVersion>
+	<SilBuildTasksDll>$(NuGetToolsPath)/packages/SIL.BuildTasks.$(SilBuildTasksVersion)/tools/SIL.BuildTasks.dll</SilBuildTasksDll>
+  </PropertyGroup>
+
+  <UsingTask TaskName="FileUpdate" AssemblyFile="$(SilBuildTasksDll)" Condition="Exists('$(SilBuildTasksDll)')" />
+
+  <Target Name="Restore" DependsOnTargets="CheckPrerequisites">
+	<Exec Command='$(NuGetCommand) install SIL.BuildTasks -version $(SilBuildTasksVersion) -solutionDirectory $(NuGetToolsPath)'
+		Condition="!Exists('$(SilBuildTasksDll)')" />
+  </Target>
+
+  <Target Name="StampLicenseYear" DependsOnTargets="Restore">
+	<FileUpdate File="resources\License.rtf" RegEx='COPYRIGHTYEARPLACEHOLDER' ReplacementText="$([System.DateTime]::Now.ToString(yyyy))" />
+  </Target>
+</Project>
diff --git a/src/Installer/ChorusHub.wxs b/src/Installer/ChorusHub.wxs
index a740c45e6..b17d90665 100644
--- a/src/Installer/ChorusHub.wxs
+++ b/src/Installer/ChorusHub.wxs
@@ -1,7 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- These variables define the Windows Installer product version, product code and upgrade code. They   -->
-<!-- will be used later on in this file.                                                                 -->
-<?define Property_ProductVersion = ".*" ?>
 <!-- Generate a new one for each installer, since it only uses the major upgrade approach for msi installers.
 cf: http://wix.sourceforge.net/manual-wix3/major_upgrade.htm
 and http://www.joyofsetup.com/2010/01/16/major-upgrades-now-easier-than-ever/
@@ -14,9 +11,9 @@ for details on why going the major upgrade route is the right answer for an msi-
 http://blogs.msdn.com/robmen/archive/2003/10/04/56479.aspx -->
 
 <Wix xmlns="http://schemas.microsoft.com/wix/2006/wi" xmlns:fire="http://schemas.microsoft.com/wix/FirewallExtension" xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
-  <Product Id="$(var.Property_ProductCode)" Name="Chorus Hub $(var.Property_ProductVersion)" Language="1033" Version="$(var.Property_ProductVersion)" Manufacturer="SIL" UpgradeCode="$(var.Property_UpgradeCode)">
+  <Product Id="$(var.Property_ProductCode)" Name="Chorus Hub $(var.ProductVersion)" Language="1033" Version="$(var.ProductVersion)" Manufacturer="SIL" UpgradeCode="$(var.Property_UpgradeCode)">
 	<!-- autogenerated package id -->
-	<Package Id="*" Compressed="yes" InstallerVersion="200" InstallScope="perMachine" />
+	<Package Id="*" Compressed="yes" InstallerVersion="300" InstallScope="perMachine" />
     <WixVariable Id="WixUILicenseRtf" Value="resources\License.rtf" />
     <WixVariable Id="WixUIDialogBmp" Value="resources\MSIBackground.bmp" />
 
@@ -71,7 +68,7 @@ http://blogs.msdn.com/robmen/archive/2003/10/04/56479.aspx -->
 						<!--<fire:FirewallException Id="ChorusHubFireWallException" Name="Chorus Hub Send/Receive Client" Program="[#ChorusHub.exe]" Scope="localSubnet" IgnoreFailure="yes"/> -->
 					</Component>
 					<Component Id="RegInstallationDir" Guid="C1EECD52-E382-11DE-8A39-0800200C9A66">
-						<RegistryKey Id="keyChorusHub.exe" Action="createAndRemoveOnUninstall" Root="HKLM" Key="SOFTWARE\[Manufacturer]\Chorus Hub">
+						<RegistryKey Id="keyChorusHub.exe" ForceDeleteOnUninstall="yes" Root="HKLM" Key="SOFTWARE\[Manufacturer]\Chorus Hub">
 							<RegistryValue Id="ChorusHubInstallationDir" Type="string" Value="[INSTALLDIR]" Name="InstallationDir"/>
 						</RegistryKey>
 					</Component>
@@ -84,7 +81,7 @@ http://blogs.msdn.com/robmen/archive/2003/10/04/56479.aspx -->
 						<File Id="Autofac.dll" Name="Autofac.dll" KeyPath="yes" Source="..\..\output\Release\net461\Autofac.dll" />
 					</Component>
 					<Component Id="chorushelp.chm" Guid="C1EECD56-E382-11DE-8A39-0800200C9A66">
-						<File Id="chorushelp.chm" Name="Chorus_Help.chm" KeyPath="yes" Source="..\..\lib\Chorus_Help.chm"/>
+						<File Id="chorushelp.chm" Name="Chorus_Help.chm" KeyPath="yes" Source="..\..\DistFiles\Help\Chorus_Help.chm"/>
 					</Component>
 					<!-- used by chorus help -->
 					<Component Id="Vulcan.Uczniowie.HelpProvider.dll" Guid="C1EEF450-E382-11DE-8A39-0800200C9A66">
diff --git a/src/Installer/ChorusMergeModule.wxs b/src/Installer/ChorusMergeModule.wxs
index 8cc262412..703c51970 100644
--- a/src/Installer/ChorusMergeModule.wxs
+++ b/src/Installer/ChorusMergeModule.wxs
@@ -54,7 +54,7 @@ http://blogs.msdn.com/robmen/archive/2003/10/04/56479.aspx -->
 		  <File Id="chorusmerge.exe" Name="chorusmerge.exe" KeyPath="yes" Source="..\..\output\Release\net461\chorusmerge.exe" />
 		</Component>
 		<Component Id="chorushelp.chm" Guid="C1EDBBE9-E382-11DE-8A39-0800200C9A66">
-		  <File Id="chorushelp.chm" Name="Chorus_Help.chm" KeyPath="yes" Source="..\..\lib\Chorus_Help.chm"/>
+		  <File Id="chorushelp.chm" Name="Chorus_Help.chm" KeyPath="yes" Source="..\..\DistFiles\Help\Chorus_Help.chm"/>
 		</Component>
 
 		<!-- used by chorus help -->
diff --git a/src/Installer/resources/License.rtf b/src/Installer/resources/License.rtf
index 0f721115c503771e5d80c0dff549abb459350568..b2b21c5c1701cdb5441ec4873fad882e1c4e38e9 100644
GIT binary patch
delta 18
ZcmZqW>EhYY$H;1AU}&JbxsS1&1pqSJ1sMPU

delta 12
TcmeC;Y313_$GCYiV>t@|9L@wO