Skip to content
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.

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

Warn if SymbolPackageFormat set to snupkg #14032

Merged
merged 2 commits into from
Sep 20, 2023
Merged

Warn if SymbolPackageFormat set to snupkg #14032

merged 2 commits into from
Sep 20, 2023

Conversation

RussKie
Copy link
Member

@RussKie RussKie commented Sep 15, 2023

To avoid the repeat of dotnet/extensions#4406, warn if SymbolPackageFormat property is set to 'snupkg'.

If necessary, the warning can be suppressed with SuppressSymbolPackageFormatValidation=true.

. . .

Tested locally against https://github.com/dotnet/extensions/ @ ef72a4125a8f7f76b62024e273e90f53453b8f68.

With <SymbolPackageFormat>snupkg</SymbolPackageFormat>:

Build FAILED.

C:\Users\user\.nuget\packages\microsoft.dotnet.arcade.sdk\8.0.0-beta.23451.1\tools\Pack.targets(12,5): error : <SymbolPackageFormat>snupkg</SymbolPackageFormat> is not supported by the 
Arcade SDK. [D:\Development\dotnet-extensions\src\Libraries\Microsoft.AspNetCore.Testing\Microsoft.AspNetCore.Testing.csproj]

With the added suppression (<SuppressSymbolPackageFormatValidation>true</SuppressSymbolPackageFormatValidation>):

  Successfully created package 'D:\Development\dotnet-extensions\artifacts\packages\Debug\Shipping\Microsoft.AspNetCore.Testing.8.0.0-dev.nupkg'.
  Successfully created package 'D:\Development\dotnet-extensions\artifacts\packages\Debug\Shipping\Microsoft.AspNetCore.Testing.8.0.0-dev.snupkg'.

With the property removed:

  Successfully created package 'D:\Development\dotnet-extensions\artifacts\packages\Debug\Shipping\Microsoft.AspNetCore.Testing.8.0.0-dev.nupkg'.
  Successfully created package 'D:\Development\dotnet-extensions\artifacts\packages\Debug\Shipping\Microsoft.AspNetCore.Testing.8.0.0-dev.symbols.nupkg'.

@RussKie RussKie requested a review from mmitche September 15, 2023 02:02
@RussKie RussKie force-pushed the warn_on_snupkg branch 2 times, most recently from cd4e2ec to 173301e Compare September 18, 2023 04:07
To avoid the repeat of dotnet/extensions#4406,
warn if SymbolPackageFormat property is set to 'snupkg'.

If necessary, the warning can be suppressed with SuppressSymbolPackageFormatValidation=true.
@RussKie
Copy link
Member Author

RussKie commented Sep 19, 2023

@mmitche @dotnet/arcade-contrib may I please get some guidance with the failing tests? I don't think my change caused those as I see other PRs failing with the same error.

@ViktorHofer
Copy link
Member

Just curious, what hinders Arcade from supporting snupkgs?

@RussKie
Copy link
Member Author

RussKie commented Sep 19, 2023

Just curious, what hinders Arcade from supporting snupkgs?

#1959 <-- this?

@mmitche
Copy link
Member

mmitche commented Sep 19, 2023

Nothing specific. The symbol publishing process needs to be updated though. You need to publish a binary with a symbol, and because snupkg doesn't contain the binary, this is a bit more complex than it is today.

But we should support snupkg

@hoyosjs
Copy link
Member

hoyosjs commented Sep 19, 2023

The main problem with snupkg is that we can't easily convert portable PDBs to full PDBs without the PE. As the restriction goes away, snupkg makes sense and should be a straightforward migration.

@RussKie RussKie merged commit f97854d into main Sep 20, 2023
@RussKie RussKie deleted the warn_on_snupkg branch September 20, 2023 06:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants