libgit2 / libgit2/libgit2sharp

Replace <PackageLicenseFile> with <PackageLicenseExpression>

オープン
#2,098 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
C#
スター
3.5k
フォーク
925
PR マージ指標
30日以内にマージされた PR はありません

説明

Hi there!

We are currently adapting a package approval workflow, where packages are approved or blocked based on certain criteria. One very important criterion is the package's license. There is a list of approved licenses (like MIT, Apache, BSD, ...) and a list of licenses that cannot be used.

Although your package seems to be under MIT license, it's hard to auto-approve this package, because it uses an embedded license file instead of an SPDX tag (https://spdx.github.io/spdx-spec/v2-draft/SPDX-license-list/). As a result, the license does not show up in the package's metadata and cannot be automatically processed.

Reproduction steps

Compare e.g. the "About" page of https://www.nuget.org/packages/LibGit2Sharp with https://www.nuget.org/packages/Microsoft.Data.SqlClient, where the latter clearly states the package's license, while your package does not.

Expected behavior

I would expect the package's license to be clearly shown in its metadata.

Actual behavior

This package's metadata refers to an embedded license file instead.

Version of LibGit2Sharp (release number or SHA1)

All versions up to 0.30.0

Operating system(s) tested; .NET runtime tested

Not specific to OS or .NET runtime

Solution

Would you consider using an SPDX license expression? Basically, all that is needed is replacing the line
<PackageLicenseFile>App_Readme/LICENSE.md</PackageLicenseFile>
with
<PackageLicenseExpression>MIT</PackageLicenseExpression>
in all *.csproj or *.props files (or whatever mechanism generates the corresponding *.nuspec file). The LICENSE file can still remain in the package, just the metadata would change. The corresponding .nuspec file should then change the line
<license type="file">App_Readme/LICENSE.md</license>
to
<license type="expression">MIT</license>

This would be a huge help for us, because with embedded license files we have to manually check and approve every single version of every package.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

リポジトリの *.csproj ファイルと *.props ファイルで PackageLicenseFile を検索し、対応する .nuspec メタデータを生成する仕組みを調査します。埋め込みファイルのメタデータを要求された MIT SPDX 式に置き換え、説明どおり LICENSE ファイルを維持し、生成された NuGet パッケージのメタデータが想定された式の形式と一致することを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp
領域
build-system, release
issue の種類
機能追加
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。