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

Add Cake.ExtractLicenses.yml #2403

Closed
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions extensions/Cake.ExtractLicenses.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Type: Addin
Name: Cake.ExtractLicenses
NuGet: Cake.ExtractLicenses
Assemblies:
- /**/Cake.ExtractLicenses.dll
Repository: https://github.com/wgnf/liz.git
ProjectUrl: https://github.com/wgnf/liz/
Author: wgnf
augustoproiete marked this conversation as resolved.
Show resolved Hide resolved
Description: >-
The Cake-Addin of the Liz-Tool - which helps to extract license-information from your solution/project
aimed on a fast and correct process.
Comment on lines +9 to +11
Copy link
Member

Choose a reason for hiding this comment

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

We should cleanup description

Categories:
- license
- extract
- information
- liz
TargetCakeVersion: 0.38.0
TargetFrameworks:
- netcoreapp3.1
- net5.0
- net6.0
Copy link
Member

Choose a reason for hiding this comment

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

Target Cake version and TFM doesn't seem to match regarding best practices. We should check this with addin author.

Copy link

Choose a reason for hiding this comment

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

Hey I'm the author of the addin. What is the issue here?
I was using the recommended .NET target version and the Cake-Version 0.38.0 to be able to support as many users as possible. Do these two not fit together?

Copy link
Member

Choose a reason for hiding this comment

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

Hey @wgnf we use major versions of Cake to introduce breaking changes to APIs, so when an addin targets Cake v0.38.0 we can't be sure it will work with Cake v1.0.0 or v2.0.0, or v3.0.0 (latest as of this writing), so your addin should ideally target the most recent major Cake version

You can see more details in the documentation: https://cakebuild.net/docs/extending/addins/best-practices#cake-reference

If you do want to support as many users as possible (and you don't mind the extra work), you should release separae versions of your addin compatible with each Cake major version you want to support.

Copy link

Choose a reason for hiding this comment

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

Yeah that totally makes sense (idk what I was thinking there 😅). I'll have a look at that in the next few days.

Copy link

Choose a reason for hiding this comment

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

Just released version 2.0.0 of Cake.ExtractLicenses now targeting version 3.0.0 (see https://github.com/wgnf/liz/releases/tag/v2.0.0)

thank you!

Copy link
Member

Choose a reason for hiding this comment

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

Awesome. Thank you @wgnf!

AnalyzedPackageVersion: 1.0.0-rc0004
AnalyzedPackageIsPrerelease: true
AnalyzedPackagePublishDate: 2022-03-01T10:05:13.1730000Z