Use SPDX license identifiers for license in shard.yml (#641)

crystal-lang · Dec 18, 2024 · 34f1c21 · 34f1c21
1 parent c75da04
commit 34f1c21
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 15 deletions.
diff --git a/docs/shard.yml.adoc b/docs/shard.yml.adoc
@@ -204,8 +204,14 @@ libraries:
 ----
 
 *license*::
-  An http://opensource.org/[OSI license] name or an URL to a license file
-(string, recommended).
+An https://spdx.github.io/spdx-spec/v3.0.1/annexes/spdx-license-expressions/[SPDX license expression]
+or an URL to a license file (string, recommended).
++
+The OSI publishes https://opensource.org/licenses-old/category[a list] of open
+source licenses and their corresponding SPDX identifiers.
++
+Examples: _Apache-2.0_, _GPL-3.0-or-later_, _Apache-2.0 OR MIT_,
+_Apache-2.0 WITH Swift-exception_, _https://example.com/LICENSE_.
 
 *repository*::
 The URL of the project's canonical repository (string, recommended).

diff --git a/docs/shard.yml.schema.json b/docs/shard.yml.schema.json
@@ -222,7 +222,7 @@
     "license": {
       "type": "string",
       "title": "license",
-      "description": "An OSI license name or an URL to a license file"
+      "description": "An SPDX license expression or an URL to a license file."
     },
     "repository": {
       "type": "string",

diff --git a/man/shard.yml.5 b/man/shard.yml.5
diff --git a/man/shards.1 b/man/shards.1
diff --git a/spec/unit/spec_spec.cr b/spec/unit/spec_spec.cr
@@ -29,7 +29,7 @@ module Shards
     it "parse license" do
       spec = Spec.from_yaml("name: shards\nversion: 0.1.0\nlicense: BSD-2-Clause")
       spec.license.should eq("BSD-2-Clause")
-      spec.license_url.should eq("http://opensource.org/licenses/BSD-2-Clause")
+      spec.license_url.should eq("https://spdx.org/licenses/BSD-2-Clause")
 
       spec = Spec.from_yaml("name: shards\nversion: 0.1.0\nlicense: http://example.com/LICENSE")
       spec.license.should eq("http://example.com/LICENSE")

diff --git a/src/spec.cr b/src/spec.cr
@@ -218,7 +218,7 @@ module Shards
         if license =~ %r(https?://)
           license
         else
-          "http://opensource.org/licenses/#{license}"
+          "https://spdx.org/licenses/#{license}"
         end
       end
     end
-Original file line number
+Diff line change
@@ Expand Up / @@ -218,7 +218,7 @@ module Shards @@
             if license =~ %r(https?://)
               license
             else
-              "http://opensource.org/licenses/#{license}"
+              "https://spdx.org/licenses/#{license}"
             end
           end
         end
@@ Expand Down @@