Skip to content

Convert NSwagStudio setup to use WiX 6 #5218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 26, 2025
Merged

Convert NSwagStudio setup to use WiX 6 #5218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
898e583
Convert to using WiX 6
lahma Jul 25, 2025
f58814c
get rid of heat
lahma Jul 25, 2025
ef75451
use Files element
lahma Jul 25, 2025
5f1ef24
cleanup
lahma Jul 25, 2025
734815b
tweak build
lahma Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .nuke/build.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
"enum": [
"Clean",
"Compile",
"InstallDependencies",
"Pack",
"Publish",
"Restore",
Expand Down
2 changes: 2 additions & 0 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@
<PackageVersion Include="Verify.Xunit" Version="30.5.0" />
<PackageVersion Include="xunit" Version="2.9.3" />
<PackageVersion Include="xunit.runner.visualstudio" Version="3.1.3" />
<PackageVersion Include="WixToolset.Util.wixext" Version="6.0.1" />
<PackageVersion Include="WixToolset.UI.wixext" Version="6.0.1" />
</ItemGroup>
<ItemGroup Condition=" '$(TargetFramework)' == 'net462' OR '$(TargetFramework)' == 'netstandard2.0' ">
<PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="2.3.0" />
Expand Down
20 changes: 5 additions & 15 deletions build/Build.Pack.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@
using Nuke.Common.IO;
using Nuke.Common.Tooling;
using Nuke.Common.Tools.DotNet;
using Nuke.Common.Tools.MSBuild;
using Nuke.Common.Tools.NuGet;

using static Nuke.Common.Tools.DotNet.DotNetTasks;
using static Nuke.Common.Tools.MSBuild.MSBuildTasks;
using static Nuke.Common.Tools.NuGet.NuGetTasks;

using Project = Microsoft.Build.Evaluation.Project;
Expand Down Expand Up @@ -60,28 +58,20 @@ public partial class Build
.SetVersion(nugetVersion)
.SetConfiguration(Configuration)
.SetOutputDirectory(ArtifactsDirectory)
.SetDeterministic(IsServerBuild)
.SetContinuousIntegrationBuild(IsServerBuild)
.EnableNoRestore()
.EnableNoBuild()
);
}

Serilog.Log.Information("Build WiX installer");

(SourceDirectory / "NSwagStudio.Installer" / "bin").CreateOrCleanDirectory();

MSBuild(x => x
.SetTargetPath(GetProject("NSwagStudio.Installer"))
.SetTargets("Rebuild")
.SetAssemblyVersion(VersionPrefix)
.SetFileVersion(VersionPrefix)
.SetInformationalVersion(VersionPrefix)
DotNetBuild(x => x
.SetProjectFile(GetProject("NSwagStudio.Installer"))
.SetConfiguration(Configuration)
.SetMaxCpuCount(Environment.ProcessorCount)
.SetNodeReuse(IsLocalBuild)
.SetVerbosity(MSBuildVerbosity.Minimal)
.SetProperty("Deterministic", IsServerBuild)
.SetProperty("ContinuousIntegrationBuild", IsServerBuild)
.EnableNoRestore()
.SetVerbosity(DotNetVerbosity.minimal)
);

// gather relevant artifacts
Expand Down
86 changes: 15 additions & 71 deletions build/Build.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,9 @@
using Nuke.Common.ProjectModel;
using Nuke.Common.Tooling;
using Nuke.Common.Tools.DotNet;
using Nuke.Common.Tools.MSBuild;
using Nuke.Common.Tools.Npm;
using Nuke.Common.Utilities;
using Nuke.Common.Utilities.Collections;

using static Nuke.Common.Tools.Chocolatey.ChocolateyTasks;
using static Nuke.Common.Tools.DotNet.DotNetTasks;
using static Nuke.Common.Tools.MSBuild.MSBuildTasks;
using static Nuke.Common.Tools.Npm.NpmTasks;
using Project = Nuke.Common.ProjectModel.Project;

Expand Down Expand Up @@ -127,18 +122,6 @@ protected override void OnBuildInitialized()
ArtifactsDirectory.CreateOrCleanDirectory();
});

Target InstallDependencies => _ => _
.Before(Restore, Compile)
.OnlyWhenDynamic(() => !IsServerBuild)
.Executes(() =>
{
Chocolatey("install wixtoolset -y");
NpmInstall(x => x
.EnableGlobal()
.AddPackages("dotnettools")
);
});

Target Restore => _ => _
.Executes(() =>
{
Expand All @@ -163,60 +146,21 @@ protected override void OnBuildInitialized()

Serilog.Log.Information("Build and copy full .NET command line with configuration {Configuration}", Configuration);

if (IsRunningOnWindows)
{
DotNetMSBuild(x => x
.SetTargetPath(GetProject("NSwagStudio"))
.SetAssemblyVersion(VersionPrefix)
.SetFileVersion(VersionPrefix)
.SetInformationalVersion(VersionPrefix)
.SetConfiguration(Configuration)
.SetMaxCpuCount(Environment.ProcessorCount)
.SetNodeReuse(IsLocalBuild)
.SetVerbosity(DotNetVerbosity.minimal)
.SetDeterministic(IsServerBuild)
.SetContinuousIntegrationBuild(IsServerBuild)
// ensure we don't generate too much output in CI run
// 0 Turns off emission of all warning messages
// 1 Displays severe warning messages
.SetWarningLevel(IsServerBuild ? 0 : 1)
);

MSBuild(x => x
.SetTargetPath(SolutionFile)
.SetAssemblyVersion(VersionPrefix)
.SetFileVersion(VersionPrefix)
.SetInformationalVersion(VersionPrefix)
.SetConfiguration(Configuration)
.SetMaxCpuCount(Environment.ProcessorCount)
.SetNodeReuse(IsLocalBuild)
.SetVerbosity(MSBuildVerbosity.Minimal)
.SetProperty("Deterministic", IsServerBuild)
.SetProperty("ContinuousIntegrationBuild", IsServerBuild)
// ensure we don't generate too much output in CI run
// 0 Turns off emission of all warning messages
// 1 Displays severe warning messages
.SetWarningLevel(IsServerBuild ? 0 : 1)
);
}
else
{
DotNetBuild(x => x
.SetProjectFile(SolutionFile)
.SetAssemblyVersion(VersionPrefix)
.SetFileVersion(VersionPrefix)
.SetInformationalVersion(VersionPrefix)
.SetConfiguration(Configuration)
.SetVerbosity(DotNetVerbosity.minimal)
.SetDeterministic(IsServerBuild)
.SetContinuousIntegrationBuild(IsServerBuild)
// ensure we don't generate too much output in CI run
// 0 Turns off emission of all warning messages
// 1 Displays severe warning messages
.SetWarningLevel(IsServerBuild ? 0 : 1)
.EnableNoRestore()
);
}
DotNetBuild(x => x
.SetProjectFile(SolutionFile)
.SetAssemblyVersion(VersionPrefix)
.SetFileVersion(VersionPrefix)
.SetInformationalVersion(VersionPrefix)
.SetConfiguration(Configuration)
.SetVerbosity(DotNetVerbosity.minimal)
.SetDeterministic(IsServerBuild)
.SetContinuousIntegrationBuild(IsServerBuild)
// ensure we don't generate too much output in CI run
// 0 Turns off emission of all warning messages
// 1 Displays severe warning messages
.SetWarningLevel(IsServerBuild ? 0 : 1)
.EnableNoRestore()
);

// later steps need to have binaries in correct places
PublishAndCopyConsoleProjects();
Expand Down
54 changes: 10 additions & 44 deletions src/NSwagStudio.Installer/NSwagStudio.Installer.wixproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<Project Sdk="WixToolset.Sdk/6.0.1">

<PropertyGroup>
<ProductVersion>3.10</ProductVersion>
<ProjectGuid>50dcc09c-7349-4bac-8833-261a641e0669</ProjectGuid>
<SchemaVersion>2.0</SchemaVersion>
<OutputName>NSwagStudio</OutputName>
<OutputType>Package</OutputType>
</PropertyGroup>
<PropertyGroup>
<SuppressIces>ICE69</SuppressIces>
<SuppressIces>ICE61;ICE69</SuppressIces>
<OutputPath>..\..\artifacts\bin\NSwagStudio.Installer\$(Configuration)\</OutputPath>
<IntermediateOutputPath>..\..\artifacts\obj\NSwagStudio.Installer\$(Configuration)\</IntermediateOutputPath>
<DefineConstants>SourcePath=..\..\NSwagStudio\$(Configuration)</DefineConstants>
</PropertyGroup>
<ItemGroup>
<Compile Include="Generated.wxs" />
<Compile Include="Product.wxs" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\NSwagStudio\NSwagStudio.csproj">
<Name>NSwagStudio</Name>
<Project>{dada2d11-14e2-40b1-b31d-b68d6f18378c}</Project>
<Private>True</Private>
<DoNotHarvest>True</DoNotHarvest>
<RefProjectOutputGroups>Binaries;Content;Satellites</RefProjectOutputGroups>
<RefTargetDir>INSTALLFOLDER</RefTargetDir>
</ProjectReference>
</ItemGroup>

<ItemGroup>
<WixExtension Include="WixUtilExtension">
<HintPath>$(WixExtDir)\WixUtilExtension.dll</HintPath>
<Name>WixUtilExtension</Name>
</WixExtension>
<WixExtension Include="WixUIExtension">
<HintPath>$(WixExtDir)\WixUIExtension.dll</HintPath>
<Name>WixUIExtension</Name>
</WixExtension>
<PackageReference Include="WixToolset.Util.wixext" />
<PackageReference Include="WixToolset.UI.wixext" />
</ItemGroup>
<Import Project="$(WixTargetsPath)" Condition=" '$(WixTargetsPath)' != '' " />
<Import Project="$(MSBuildExtensionsPath32)\Microsoft\WiX\v3.x\Wix.targets" Condition=" '$(WixTargetsPath)' == '' AND Exists('$(MSBuildExtensionsPath32)\Microsoft\WiX\v3.x\Wix.targets') " />
<Target Name="Heat" AfterTargets="PreBuildEvent">
<PropertyGroup>
<DefineConstants>SourcePath=..\..\artifacts\bin\NSwagStudio\$(Configuration)</DefineConstants>
</PropertyGroup>
<HeatDirectory
DirectoryRefId="RootDirectory"
VerboseOutput="true"
AutogenerateGuids="true"
GenerateGuidsNow="true"
SuppressRootDirectory="true"
OutputFile="Generated.wxs"
RunAsSeparateProcess="true"
PreprocessorVariable="var.SourcePath"
Directory="..\..\artifacts\bin\NSwagStudio\$(Configuration)"
ComponentGroupName="SourceComponentGroup"
ToolPath="$(WixToolPath)" />
</Target>
</Project>

</Project>
Loading
Loading