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

Change all of our NuGet metadata to use license expressions (OSOE-852) #761

Closed
4 tasks done
Piedone opened this issue May 13, 2024 · 5 comments · Fixed by #789
Closed
4 tasks done

Change all of our NuGet metadata to use license expressions (OSOE-852) #761

Piedone opened this issue May 13, 2024 · 5 comments · Fixed by #789
Assignees
Labels
enhancement New feature or request

Comments

@Piedone
Copy link
Member

Piedone commented May 13, 2024

NuGet license expressions make the type of license of a package readily apparent, and help with license checkers, and thus getting adoption for our packages. See aaubry/YamlDotNet#903 for an example of such a change but that's about nuspec files.

So, since all of our packages use a BSD-3-Clause license anyway, let's change all of our open-source csprojs from this:

<PackageLicenseFile>License.md</PackageLicenseFile>

To this:

<PackageLicenseExpression>BSD-3-Clause</PackageLicenseExpression>

Or if we have nuspec files then to this:

<license type="expression">BSD-3-Clause</license>
  • Test the change proposed above with an alpha release of any single-package project first.
  • Change all NuGet-published projects of ours.
  • Check if lines like <None Include="License.md" Pack="true" PackagePath="" /> can be removed from csprojs too; most possibly yes, then remove them.
  • Update our documentation.

Jira issue

@Piedone Piedone added the enhancement New feature or request label May 13, 2024
@github-actions github-actions bot changed the title Change all of our NuGet metadata to use license expressions Change all of our NuGet metadata to use license expressions (OSOE-852) May 13, 2024
@AydinE
Copy link
Contributor

AydinE commented Jun 10, 2024

Have created a PR the only thing I am not sure on is which documentations need to be updated to reflect these changes.

@Piedone
Copy link
Member Author

Piedone commented Jun 10, 2024

This wiki page: https://lombiq.atlassian.net/wiki/spaces/DEV/pages/2609840133/Preparing+a+.NET+project+to+be+published+on+NuGet

@Piedone
Copy link
Member Author

Piedone commented Jun 10, 2024

Can you please link to where you tested this?

Test the change proposed above with an alpha release of any single-package project first.

@AydinE
Copy link
Contributor

AydinE commented Jun 10, 2024

Oh I put that under the description of the PR:
#789 (comment)

@Piedone
Copy link
Member Author

Piedone commented Jun 10, 2024

OK, great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
2 participants