Create REUSE.toml schema

.github/workflows/tests.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: REUSE Compliance Check
-      uses: fsfe/reuse-action@v3
+      uses: fsfe/reuse-action@v5
 
   build:
     runs-on: ubuntu-latest

REUSE.toml

@@ -0,0 +1,55 @@
+version = 1
+
+[[annotations]]
+path = "site/static/*.schema.json"
+precedence = "override"
+SPDX-FileCopyrightText = "2025 Free Software Foundation Europe <https://fsfe.org>"
+SPDX-License-Identifier = "CC0-1.0"
+
+[[annotations]]
+path = "site/static/fonts/roboto/**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2018 Google"
+SPDX-License-Identifier = "Apache-2.0"
+
+[[annotations]]
+path = "site/static/fonts/fontawesome/css/**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Font Awesome <https://fontawesome.com>"
+SPDX-License-Identifier = "MIT"
+
+[[annotations]]
+path = "site/static/fonts/fontawesome/webfonts/**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Font Awesome <https://fontawesome.com>"
+SPDX-License-Identifier = "OFL-1.1"
+
+[[annotations]]
+path = "site/static/fonts/fontawesome/webfonts/**.svg"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Font Awesome <https://fontawesome.com>"
+SPDX-License-Identifier = "CC-BY-4.0"
+
+[[annotations]]
+path = "site/static/img/**.png"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2019 Free Software Foundation Europe <https://fsfe.org>"
+SPDX-License-Identifier = "CC-BY-SA-4.0"
+
+[[annotations]]
+path = "site/static/img/**.jpg"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2019 Free Software Foundation Europe <https://fsfe.org>"
+SPDX-License-Identifier = "CC-BY-SA-4.0"
+
+[[annotations]]
+path = "site/i18n/**.json"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2019 Free Software Foundation Europe <https://fsfe.org>"
+SPDX-License-Identifier = "CC-BY-SA-4.0"
+
+[[annotations]]
+path = "site/po/**.po**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2020 Free Software Foundation Europe e.V."
+SPDX-License-Identifier = "CC-BY-SA-4.0"

site/content/en/faq.md

@@ -416,7 +416,8 @@ SPDX-License-Identifier = "CC0-1.0"
 ```
 
 The [REUSE Specification](/spec) documents more thoroughly how `REUSE.toml` can
-be used.
+be used. You can find a JSON schema for `REUSE.toml` at
+<https://reuse.software/reuse-toml-v1.schema.json>.
 
 ## ... override erroneous REUSE information? {#override-info}
 

site/content/en/spec-3.2.md

@@ -309,6 +309,10 @@ SPDX-FileCopyrightText = "2019 Jane Doe"
 SPDX-License-Identifier = "CC0-1.0"
 ```
 
+A JSON schema of version 1 of `REUSE.toml` is provided at
+<https://reuse.software/reuse-toml-v1.schema.json>. This Specification remains
+authoritative.
+
 ### DEP5 (deprecated)
 
 Licensing Information MAY be associated with a file through a DEP5 file, but you

site/content/en/spec-3.3.md

@@ -317,6 +317,10 @@ SPDX-FileCopyrightText = "2019 Jane Doe"
 SPDX-License-Identifier = "CC0-1.0"
 ```
 
+A JSON schema of version 1 of `REUSE.toml` is provided at
+<https://reuse.software/reuse-toml-v1.schema.json>. This Specification remains
+authoritative.
+
 ### DEP5 (deprecated)
 
 Licensing Information MAY be associated with a file through a DEP5 file, but you

site/static/reuse-toml-v1.schema.json

@@ -0,0 +1,85 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://reuse.software/reuse-toml-v1.schema.json",
+  "$comment": "See https://reuse.software/spec-3.2/ for details",
+  "title": "REUSE.toml global licensing file, version 1",
+  "description": "A configuration file which declares the copyright and licensing of files in a directory tree",
+  "type": "object",
+  "required": ["version"],
+  "properties": {
+    "version": {
+      "description": "The schema version of the REUSE.toml file",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "examples": [1]
+    },
+    "annotations": {
+      "description": "Annotation object array",
+      "type": "array",
+      "items": {
+        "description": "Annotation object",
+        "type": "object",
+        "required": ["path"],
+        "properties": {
+          "path": {
+            "description": "Relative path(s) to files, with optional globbing",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            ],
+            "examples": [["po/*.po", "po/*.pot"], "tests/resources/**"]
+          },
+          "precedence": {
+            "description": "The order of precedence for Licensing Information between this REUSE.toml file and the files covered by path",
+            "enum": ["closest", "aggregate", "override"],
+            "default": "closest",
+            "examples": ["closest"]
+          },
+          "SPDX-FileCopyrightText": {
+            "description": "Copyright notice(s)",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            ],
+            "examples": [
+              "2019 Jane Doe <[email protected]>",
+              "© 2019 John Doe <[email protected]>",
+              "Contributors to Example Project <https://project.example.com>",
+              "(C) Example Cooperative <[email protected]>",
+              "Copyright 2016, 2018-2019 Joe Anybody"
+            ]
+          },
+          "SPDX-License-Identifier": {
+            "description": "License identifier(s)",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            ],
+            "examples": ["GPL-3.0-or-later", "GPL-3.0-or-later OR Apache-2.0"]
+          }
+        }
+      }
+    }
+  }
+}