Skip to content

Stop generating *.runtimeconfig.dev.json #17014

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 8 commits into from
May 3, 2021
Merged

Stop generating *.runtimeconfig.dev.json #17014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d85bc33
Stop generating *.runtimeconfig.dev.json
benvillalobos Apr 19, 2021
3d6bdaf
Only skip runtimeconfig.dev.json generation if on net6.0+
benvillalobos Apr 20, 2021
26414ea
Fix closing property syntax
benvillalobos Apr 20, 2021
7b522a2
Version 1 of testing generation of runtimeconfig.dev.json
benvillalobos Apr 22, 2021
914cd2e
Set property to stop generating runtimeconfig.dev.json in M.NET.Sdk.t…
benvillalobos Apr 22, 2021
913ee61
If user-set GenerateRuntimeConfigDevFile to take priority
benvillalobos Apr 23, 2021
567a6d6
Add tests for user-set property taking priority
benvillalobos Apr 23, 2021
cb41b9f
Clean up unit tests
benvillalobos Apr 28, 2021
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
9 changes: 8 additions & 1 deletion src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,19 @@ Copyright (c) .NET Foundation. All rights reserved.
<GenerateRuntimeConfigurationFilesInputs Include="$(UserRuntimeConfig)" Condition=" Exists($(UserRuntimeConfig)) " />
</ItemGroup>

<PropertyGroup Condition="'$(GenerateRuntimeConfigDevFile)' == ''">
<GenerateRuntimeConfigDevFile>true</GenerateRuntimeConfigDevFile>
<!-- Post-net6.0, stop generating *.runtimeconfig.dev.json files to reduce probing paths. -->
<!-- https://github.com/dotnet/sdk/issues/16818 -->
<GenerateRuntimeConfigDevFile Condition="'$(TargetFrameworkIdentifier)' == '.NETCoreApp' and $([MSBuild]::VersionGreaterThanOrEquals($(TargetFrameworkVersion), '6.0'))">false</GenerateRuntimeConfigDevFile>
</PropertyGroup>

<PropertyGroup>
<ProjectDepsFileName Condition="'$(ProjectDepsFileName)' == ''">$(AssemblyName).deps.json</ProjectDepsFileName>
<ProjectDepsFilePath Condition="'$(ProjectDepsFilePath)' == ''">$(TargetDir)$(ProjectDepsFileName)</ProjectDepsFilePath>
<ProjectRuntimeConfigFileName Condition="'$(ProjectRuntimeConfigFileName)' == ''">$(AssemblyName).runtimeconfig.json</ProjectRuntimeConfigFileName>
<ProjectRuntimeConfigFilePath Condition="'$(ProjectRuntimeConfigFilePath)' == ''">$(TargetDir)$(ProjectRuntimeConfigFileName)</ProjectRuntimeConfigFilePath>
<ProjectRuntimeConfigDevFilePath Condition="'$(ProjectRuntimeConfigDevFilePath)' == ''">$(TargetDir)$(AssemblyName).runtimeconfig.dev.json</ProjectRuntimeConfigDevFilePath>
<ProjectRuntimeConfigDevFilePath Condition="'$(ProjectRuntimeConfigDevFilePath)' == '' and $(GenerateRuntimeConfigDevFile) == 'true'">$(TargetDir)$(AssemblyName).runtimeconfig.dev.json</ProjectRuntimeConfigDevFilePath>
<IncludeMainProjectInDepsFile Condition=" '$(IncludeMainProjectInDepsFile)' == '' ">true</IncludeMainProjectInDepsFile>
</PropertyGroup>

Expand Down
54 changes: 54 additions & 0 deletions src/Tests/Microsoft.NET.Build.Tests/GivenThatWeWantToBuildANetCoreApp.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,60 @@ public static void Main()

}

[Theory]
[InlineData("netcoreapp2.0", true)]
[InlineData("netcoreapp3.0", true)]
[InlineData("net5.0", true)]
[InlineData("net6.0", false)]
public void It_stops_generating_runtimeconfig_dev_json_after_net6(string targetFramework, bool shouldGenerateRuntimeConfigDevJson)
{
TestProject proj = new TestProject()
{
Name = "NetCoreApp",
ProjectSdk = "Microsoft.NET.Sdk",
IsExe = true,
TargetFrameworks = targetFramework,
IsSdkProject = true
};

var buildCommand = new BuildCommand(_testAssetsManager.CreateTestProject(proj, identifier: targetFramework));
var runtimeconfigFile = Path.Combine(
buildCommand.GetOutputDirectory(targetFramework).FullName,
$"{proj.Name}.runtimeconfig.dev.json");

buildCommand.Execute();
File.Exists(runtimeconfigFile).Should().Be(shouldGenerateRuntimeConfigDevJson);
}

[Theory]
[InlineData("netcoreapp2.0")]
[InlineData("netcoreapp3.0")]
[InlineData("net5.0")]
[InlineData("net6.0")]
public void It_stops_generating_runtimeconfig_dev_json_after_net6_allow_property_override(string targetFramework)
{
TestProject proj = new TestProject()
{
Name = "NetCoreApp",
ProjectSdk = "Microsoft.NET.Sdk",
IsExe = true,
TargetFrameworks = targetFramework,
IsSdkProject = true
};

var buildCommand = new BuildCommand(_testAssetsManager.CreateTestProject(proj, identifier: targetFramework));
var runtimeconfigFile = Path.Combine(
buildCommand.GetOutputDirectory(targetFramework).FullName,
$"{proj.Name}.runtimeconfig.dev.json");

// GenerateRuntimeConfigDevFile overrides default behavior
buildCommand.Execute("/p:GenerateRuntimeConfigDevFile=true");
File.Exists(runtimeconfigFile).Should().BeTrue();

buildCommand.Execute("/p:GenerateRuntimeConfigDevFile=false");
File.Exists(runtimeconfigFile).Should().BeFalse();
}

[Theory]
[InlineData("netcoreapp2.0")]
[InlineData("netcoreapp3.0")]
Expand Down