Merge pull request #134 from fcollonval/ft/json-config

Add JSON Schema for Config

Author: Steven Silvester

MANIFEST.in

@@ -1,3 +1,4 @@
 include *.md
 include LICENSE
 prune media
+include jupyter_releaser/schema.json

jupyter_releaser/schema.json

@@ -0,0 +1,49 @@
+{
+  "title": "Jupyter Releaser Metadata",
+  "version": "0.1.0",
+  "description": "Jupyter Releaser configuration metadata",
+  "properties": {
+    "skip": {
+      "title": "Skip Steps",
+      "description": "A list of steps to skip in actions",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "options": {
+      "title": "Overrides for default options",
+      "description": "Overrides for cli option names",
+      "additionalProperties": {
+        "anyOf": [
+          { "type": "string" },
+          {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        ]
+      }
+    },
+    "hooks": {
+      "title": "Action Step Hooks",
+      "description": "Hooks to run before or after action steps",
+      "patternProperties": {
+        "^(before|after)-.*$": {
+          "anyOf": [
+            { "type": "string" },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  "additionalProperties": false,
+  "type": "object"
+}

jupyter_releaser/util.py

@@ -18,10 +18,12 @@
 from subprocess import PIPE
 
 import toml
+from jsonschema import Draft4Validator as Validator
 from pkg_resources import parse_version
 
 from jupyter_releaser.tee import run as tee
 
+HERE = osp.dirname(osp.abspath(__file__))
 PYPROJECT = Path("pyproject.toml")
 SETUP_PY = Path("setup.py")
 SETUP_CFG = Path("setup.cfg")
@@ -269,18 +271,21 @@ def retry(cmd, **kwargs):
 
 def read_config():
     """Read the jupyter-releaser config data"""
+    config = {}
     if JUPYTER_RELEASER_CONFIG.exists():
-        return toml.loads(JUPYTER_RELEASER_CONFIG.read_text(encoding="utf-8"))
+        config = toml.loads(JUPYTER_RELEASER_CONFIG.read_text(encoding="utf-8"))
 
-    if PYPROJECT.exists():
+    elif PYPROJECT.exists():
         data = toml.loads(PYPROJECT.read_text(encoding="utf-8"))
-        config = data.get("tool", {}).get("jupyter-releaser")
-        if config:
-            return config
+        config = data.get("tool", {}).get("jupyter-releaser") or {}
 
-    if PACKAGE_JSON.exists():
+    elif PACKAGE_JSON.exists():
         data = json.loads(PACKAGE_JSON.read_text(encoding="utf-8"))
         if "jupyter-releaser" in data:
-            return data["jupyter-releaser"]
+            config = data["jupyter-releaser"]
 
-    return {}
+    with open(osp.join(HERE, "schema.json")) as fid:
+        schema = json.load(fid)
+    validator = Validator(schema)
+    validator.validate(config)
+    return config

setup.cfg

@@ -32,6 +32,7 @@ install_requires =
     click
     ghapi
     github-activity~=0.1
+    jsonschema>=3.0.1
     pre-commit
     pypiserver
     pytest-check-links>=0.5