cake-build / cake-build/cake

Cake.Build doesn't generate description for nuget and non-sdk projecs

Open
#4,295 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
4.2k
Forks
778
Avg merge
1h 15m
Merged PRs (30d)
19

Description

### Discussed in https://github.com/orgs/cake-build/discussions/4293

Originally posted by **DmitryLukyanov** February 29, 2024
have quite simple nuget package creating logic with cake.build:

var nugetSettings = new NuGetPackSettings
{
OutputDirectory = "%some_path%",
Verbosity = NuGetVerbosity.Detailed,
Description = "oops, description",
Version = "2.0.0"
};

context.NuGetPack("%project_path%", nugetSettings);

It generates nuget package and set expected version, but the description value is ignored. This is what I still see in ClassLibrary1.2.0.0.nupkg:
![image](https://github.com/cake-build/cake/assets/44870738/5da461eb-aa04-497e-a705-89a0fb03d2a6)

Target framework:

v4.5.2

Description value is not appeared in the package metadata even if I manually add Description property to the .csproj file like:

asd

This question is continuation of the discussion from [here ](https://stackoverflow.com/questions/78077589/cake-build-doesnt-generate-description-for-nuget-and-non-sdk-projecs?noredirect=1#comment137649844_78077589). It looks like Description even in theory can't be filled in this case? If so, why Description field does exist?

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the NuGetPack example with NuGetPackSettings against the referenced non-SDK .csproj and inspect the resulting package metadata. Compare the behavior of the Description setting with the project’s Description property and determine which packaging path is responsible; done means the intended description is present or the limitation is clearly documented with a regression test.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.