patchdrill 0.1.0

package/schemas/patchdrill-policy.schema.json

@@ -0,0 +1,170 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://patchdrill.dev/schemas/patchdrill-policy.schema.json",
+  "title": "PatchDrill Policy",
+  "description": "Policy-as-code configuration for PatchDrill.",
+  "type": "object",
+  "additionalProperties": false,
+  "allOf": [
+    {
+      "not": {
+        "required": ["ignoredPaths", "ignore"]
+      }
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "ignoredPaths": {
+      "$ref": "#/$defs/stringArray",
+      "description": "Glob patterns removed from changed-file and added-line analysis. Do not combine with the legacy ignore alias."
+    },
+    "ignore": {
+      "$ref": "#/$defs/stringArray",
+      "description": "Legacy alias for ignoredPaths. Do not combine with ignoredPaths."
+    },
+    "failOn": {
+      "$ref": "#/$defs/severity"
+    },
+    "maxRisk": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "requiredCommands": {
+      "type": "array",
+      "description": "Commands PatchDrill runs when --run is set. Command ids and command strings must be unique across requiredCommands and optionalCommands.",
+      "items": {
+        "$ref": "#/$defs/policyCommand"
+      },
+      "default": []
+    },
+    "optionalCommands": {
+      "type": "array",
+      "description": "Commands shown in the report and run only when both --run and --run-optional are set. Command ids and command strings must be unique across requiredCommands and optionalCommands.",
+      "items": {
+        "$ref": "#/$defs/policyCommand"
+      },
+      "default": []
+    },
+    "rules": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/policyRule"
+      },
+      "default": []
+    }
+  },
+  "$defs": {
+    "severity": {
+      "type": "string",
+      "enum": ["info", "low", "medium", "high", "critical"]
+    },
+    "stringArray": {
+      "oneOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      ]
+    },
+    "pathPattern": {
+      "oneOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "minItems": 1
+        }
+      ]
+    },
+    "policyCommand": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["command"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1
+        },
+        "command": {
+          "type": "string",
+          "minLength": 1
+        },
+        "reason": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "policyRule": {
+      "type": "object",
+      "additionalProperties": false,
+      "allOf": [
+        {
+          "not": {
+            "required": ["path", "paths"]
+          }
+        }
+      ],
+      "required": ["id", "title", "severity"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1
+        },
+        "severity": {
+          "$ref": "#/$defs/severity"
+        },
+        "path": {
+          "$ref": "#/$defs/pathPattern",
+          "description": "Path glob or globs for this rule. Do not combine with paths."
+        },
+        "paths": {
+          "$ref": "#/$defs/pathPattern",
+          "description": "Alias for path. Do not combine with path."
+        },
+        "detail": {
+          "type": "string"
+        },
+        "remediation": {
+          "type": "string"
+        },
+        "weight": {
+          "type": "number",
+          "minimum": 0
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "default": []
+        }
+      }
+    }
+  }
+}

package/schemas/patchdrill-release-check.schema.json

@@ -0,0 +1,78 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://patchdrill.dev/schemas/patchdrill-release-check.schema.json",
+  "title": "PatchDrill Release Check Report",
+  "description": "Machine-readable local release-readiness diagnostics emitted by PatchDrill release-check --format json.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "ok", "summary", "checks"],
+  "properties": {
+    "schemaVersion": {
+      "type": "string",
+      "const": "1"
+    },
+    "ok": {
+      "type": "boolean"
+    },
+    "summary": {
+      "$ref": "#/$defs/releaseReadinessSummary"
+    },
+    "checks": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/releaseCheck"
+      }
+    }
+  },
+  "$defs": {
+    "releaseStatus": {
+      "type": "string",
+      "enum": ["pass", "warn", "fail"]
+    },
+    "releaseReadinessSummary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["status", "ok", "passCount", "warnCount", "failCount"],
+      "properties": {
+        "status": {
+          "type": "string",
+          "enum": ["pass", "fail"]
+        },
+        "ok": {
+          "type": "boolean"
+        },
+        "passCount": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "warnCount": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "failCount": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "releaseCheck": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["status", "title", "detail"],
+      "properties": {
+        "status": {
+          "$ref": "#/$defs/releaseStatus"
+        },
+        "title": {
+          "type": "string"
+        },
+        "detail": {
+          "type": "string"
+        },
+        "remediation": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}