Skip to content

Fix mismatch between GetPackOutputItemsTask and PackTask generated filenames #7137

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

Open
gekka wants to merge 17 commits into
base: dev
Choose a base branch
from
Open

Fix mismatch between GetPackOutputItemsTask and PackTask generated filenames #7137

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
0343ad1
Fix Nuget package file name that generated by _GetTargetFrameworksOut…
gekka Jan 10, 2026
c1d3899
Fix OutputFileNamesWithoutVersion
gekka Jan 31, 2026
a3031e3
Remove unnecessary comments
gekka Jan 31, 2026
6af6b22
Fix build failure occurring in Azure Pipelines
gekka Feb 17, 2026
1fa323c
Merge remote-tracking branch 'remotes/origin/dev' into fix-nuget-pack…
gekka Feb 20, 2026
684f75d
Fix environment variable for dotnet build in test
gekka Feb 20, 2026
463a6db
Change property name for nuspec file
gekka Feb 20, 2026
dee289b
Fix TargetFrameworks
gekka Feb 20, 2026
b149c8d
Refine test configuration
gekka Feb 20, 2026
5e4993d
Retry test
gekka Feb 21, 2026
3408ffc
Apply multiple fixes suggested by reviewer and copilot
gekka Mar 8, 2026
9cb19ec
Re-merge msbuild targets
gekka Mar 8, 2026
10761cc
Split the test functions into integration tests and unit tests.
gekka Mar 29, 2026
0d95d28
Modify build conditions to use DefineConstants from common.targets
gekka Mar 29, 2026
2ffb4a8
Merge branch 'dev' into fix-nuget-package-file-name
gekka Mar 29, 2026
6642de9
Remove integration Tests
gekka Mar 29, 2026
100e6b6
Fix current directory
gekka Mar 29, 2026
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
32 changes: 26 additions & 6 deletions src/NuGet.Core/NuGet.Build.Tasks.Pack/GetPackOutputItemsTask.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,18 @@ public class GetPackOutputItemsTask : Microsoft.Build.Utilities.Task
[Required]
public string NuspecOutputPath { get; set; }

public string NuspecInputFilePath { get; set; }

public string[] NuspecProperties { get; set; }

public bool IncludeSymbols { get; set; }

public bool IncludeSource { get; set; }

public string SymbolPackageFormat { get; set; }

public bool OutputFileNamesWithoutVersion { get; set; }

/// <summary>
/// Output items
/// </summary>
Expand All @@ -43,27 +49,41 @@ public class GetPackOutputItemsTask : Microsoft.Build.Utilities.Task

public override bool Execute()
{
var packageId = PackageId;
var packageVersion = PackageVersion;

if (!string.IsNullOrWhiteSpace(NuspecInputFilePath))
{
var nuspecReader = new NuGet.Packaging.NuspecReader(NuspecInputFilePath);
packageId = nuspecReader.GetId();
packageVersion = nuspecReader.GetVersion().ToNormalizedString();

PackArgs packArgs = new PackArgs() { Version = packageVersion };
PackTaskLogic.SetPackArgsPropertiesFromNuspecProperties(packArgs, MSBuildStringUtility.TrimAndExcludeNullOrEmpty(NuspecProperties), NuspecInputFilePath);
packageVersion = packArgs.Version;
}

NuGetVersion version;
if (!NuGetVersion.TryParse(PackageVersion, out version))
if (!NuGetVersion.TryParse(packageVersion, out version))
{
throw new ArgumentException(string.Format(
CultureInfo.CurrentCulture,
Strings.InvalidPackageVersion,
PackageVersion));
packageVersion));
}

var symbolPackageFormat = PackArgs.GetSymbolPackageFormat(MSBuildStringUtility.TrimAndGetNullForEmpty(SymbolPackageFormat));
var nupkgFileName = PackCommandRunner.GetOutputFileName(PackageId, version, isNupkg: true, symbols: false, symbolPackageFormat: symbolPackageFormat);
var nuspecFileName = PackCommandRunner.GetOutputFileName(PackageId, version, isNupkg: false, symbols: false, symbolPackageFormat: symbolPackageFormat);
var nupkgFileName = PackCommandRunner.GetOutputFileName(packageId, version, isNupkg: true, symbols: false, symbolPackageFormat: symbolPackageFormat, excludeVersion: OutputFileNamesWithoutVersion);
var nuspecFileName = PackCommandRunner.GetOutputFileName(packageId, version, isNupkg: false, symbols: false, symbolPackageFormat: symbolPackageFormat, excludeVersion: OutputFileNamesWithoutVersion);

var outputs = new List<ITaskItem>();
outputs.Add(new TaskItem(Path.Combine(PackageOutputPath, nupkgFileName)));
outputs.Add(new TaskItem(Path.Combine(NuspecOutputPath, nuspecFileName)));

if (IncludeSource || IncludeSymbols)
{
var nupkgSymbolsFileName = PackCommandRunner.GetOutputFileName(PackageId, version, isNupkg: true, symbols: true, symbolPackageFormat: symbolPackageFormat);
var nuspecSymbolsFileName = PackCommandRunner.GetOutputFileName(PackageId, version, isNupkg: false, symbols: true, symbolPackageFormat: symbolPackageFormat);
var nupkgSymbolsFileName = PackCommandRunner.GetOutputFileName(packageId, version, isNupkg: true, symbols: true, symbolPackageFormat: symbolPackageFormat, excludeVersion: OutputFileNamesWithoutVersion);
var nuspecSymbolsFileName = PackCommandRunner.GetOutputFileName(packageId, version, isNupkg: false, symbols: true, symbolPackageFormat: symbolPackageFormat, excludeVersion: OutputFileNamesWithoutVersion);

outputs.Add(new TaskItem(Path.Combine(PackageOutputPath, nupkgSymbolsFileName)));
outputs.Add(new TaskItem(Path.Combine(NuspecOutputPath, nuspecSymbolsFileName)));
Expand Down
32 changes: 24 additions & 8 deletions src/NuGet.Core/NuGet.Build.Tasks.Pack/PackTaskLogic.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,7 @@ public PackArgs GetPackArgs(IPackTaskRequest<IMSBuildItem> request)

if (!string.IsNullOrEmpty(request.NuspecFile))
{
if (request.NuspecProperties != null && request.NuspecProperties.Any())
{
packArgs.Properties.AddRange(ParsePropertiesAsDictionary(request.NuspecProperties));
if (packArgs.Properties.TryGetValue("version", out var version))
{
packArgs.Version = version;
}
}
SetPackArgsPropertiesFromNuspecProperties(packArgs, request.NuspecProperties, request.NuspecFile);
}
else
{
Expand Down Expand Up @@ -1091,6 +1084,29 @@ private static IDictionary<string, string> ParsePropertiesAsDictionary(string[]
return dictionary;
}

internal static void SetPackArgsPropertiesFromNuspecProperties(PackArgs packArgs, string[] nuspecProperties, string nuspecInputFilePath)
{
if (string.IsNullOrWhiteSpace(nuspecInputFilePath) || nuspecProperties == null || !nuspecProperties.Any())
{
return;
}

packArgs.Properties.AddRange(ParsePropertiesAsDictionary(nuspecProperties));
if (packArgs.Properties.TryGetValue("version", out var packageVersion))
{
if (!NuGetVersion.TryParse(packageVersion, out var version))
{
throw new ArgumentException(string.Format(
CultureInfo.CurrentCulture,
Strings.InvalidPackageVersion,
packageVersion));
}
packArgs.Version = version.ToNormalizedString();
}


}

private HashSet<string> InitOutputExtensions(IEnumerable<string> outputExtensions)
{
return new HashSet<string>(outputExtensions.Distinct(StringComparer.OrdinalIgnoreCase));
Expand Down
6 changes: 4 additions & 2 deletions src/NuGet.Core/NuGet.Build.Tasks/NuGet.Build.Tasks.Pack.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,14 @@ Copyright (c) .NET Foundation. All rights reserved.
<GetPackOutputItemsTask
PackageOutputPath="$(PackageOutputAbsolutePath)"
NuspecOutputPath="$(NuspecOutputAbsolutePath)"
NuspecInputFilePath="$(NuspecFile)"
Copy link
Copy Markdown
Member

@nkolev92 nkolev92 Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PackTask already takes a bunch of these properties as input.
I think for ease for maintenance, the property names should be the same.

So instead of NuspecInputFilePath, use NuspecFile.

Something else, we should use the NuspecFileAbsolutePath as https://github.com/NuGet/NuGet.Client/blob/3a2648cbab3528f4105e0dedbe60be26289379eb/src/NuGet.Core/NuGet.Build.Tasks/NuGet.Build.Tasks.Pack.targets#L265C29-L265C51 is using it.

Copy link
Copy Markdown
Author

@gekka gekka Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change the property name from NuspecInputFilePath to NuspecFile

$(AbsolutePath) doesn’t exist when GetPackOutputItemsTask is called, I changed the logic to generate it from $(NuspecFile) and pass it in.

Ideally, for maintainability, PackTask should use the output filename produced by GetPackOutputItemsTask directly, which would avoid inconsistencies from generating filenames separately. However, that would require larger changes to PackTask, so this pull request applies the minimal fix.

NuspecProperties="$(NuspecProperties)"
PackageId="$(PackageId)"
PackageVersion="$(PackageVersion)"
IncludeSymbols="$(IncludeSymbols)"
IncludeSource="$(IncludeSource)"
SymbolPackageFormat="$(SymbolPackageFormat)">

SymbolPackageFormat="$(SymbolPackageFormat)"
OutputFileNamesWithoutVersion="$(OutputFileNamesWithoutVersion)">
<Output
TaskParameter="OutputPackItems"
ItemName="_OutputPackItems" />
Expand Down
1 change: 1 addition & 0 deletions test/NuGet.Core.Tests/NuGet.Build.Tasks.Pack.Test/NuGet.Build.Tasks.Pack.Test.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\..\..\src\NuGet.Core\NuGet.Build.Tasks\NuGet.Build.Tasks.csproj" />
<ProjectReference Include="..\..\TestUtilities\Test.Utility\Test.Utility.csproj" />
<ProjectReference Include="..\..\..\src\NuGet.Core\NuGet.Build.Tasks.Pack\NuGet.Build.Tasks.Pack.csproj" />
</ItemGroup>
Expand Down
Loading
Loading