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

Cake 2.0 cleanup tasks #38

Open
3 of 5 tasks
pascalberger opened this issue Oct 11, 2021 · 6 comments
Open
3 of 5 tasks

Cake 2.0 cleanup tasks #38

pascalberger opened this issue Oct 11, 2021 · 6 comments

Comments

@pascalberger
Copy link
Member

pascalberger commented Oct 11, 2021

The following tasks are required after 2.0 has been released:

@augustoproiete
Copy link
Member

When deprecating these NuGet packages, I suggest we release a new patch increment version (branched out of v1.3.0) that:

  • Update the description with DEPRECATED. We recommend using [Cake .NET Tool](https://cakebuild.net/docs/running-builds/runners/dotnet-tool) runner moving forward. so that it shows up in the nuget.org search
  • Update the icon of the package with something that calls out attention that it's deprecated - I took a stab at be below:

cake-medium-deprecated

image

@gep13
Copy link
Member

gep13 commented Oct 11, 2021

@augustoproiete i think this is a great idea!

@pascalberger
Copy link
Member Author

@augustoproiete @gep13 I'm not a big fan of publishing a whole release just for changing icon and package metadata. What speaks against using just the deprecation feature of nuget.org?

@augustoproiete
Copy link
Member

@pascalberger I tried to explain above: The nuget.org doesn't show that a package is deprecated in the search, so you have no way to know that it's deprecated and there's no link to the recommended package.

For example, if you search for Serilog AmazonS3 you'll find these two packages below:

image

The first one is deprecated using the deprecation feature of nuget.org and the second one is the package recommended as alternative moving forward.

There's nothing that shows you any of that in the search 😞

You don't see any info about deprecation until you actually navigate to the details of a specific the package - then they show you the deprecation information.

image


Contrast that with a search for Ookii:

image

IMO, it's a much better experience.

@augustoproiete
Copy link
Member

BTW, would we need to do a full release even if our end-goal is to only deploy these two packages?

i.e. Wouldn't it be possible to download these two packages from nuget.org, change the metadata/icon with NuGet Package Explorer, Save As v1.3.1, sign with the DNF key, and publish only these two new packages?

@pascalberger
Copy link
Member Author

Decision: Deprecate packages using nuget.org deprecation feature and don't replace icons / readme to avoid shipping a new release.

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

No branches or pull requests

3 participants