feat: add json schema

.github/workflows/publish-json-schema.yml

@@ -0,0 +1,25 @@
+name: Publish JSON schema
+on:
+  push:
+    paths:
+      - 'config/lassie.schema.json'
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v2.3.4
+
+      - name: Remove all files except lassie.schema.json
+        working-directory: config
+        run: find . -mindepth 1 -maxdepth 1 ! -name "lassie.schema.json" -delete
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@4.1.4
+        with:
+          branch: gh-pages
+          folder: config
+          clean: false

README.md

@@ -55,6 +55,7 @@ Lassie can be controlled with a config file. To enable lassie for a project you
 
 ```json5
 {
+  "$schema": "https://geprog.github.io/lassie-bot-dog/lassie.schema.json",
   "plugins": {
     "auto_merge": {
       "squash": true,

config/lassie.schema.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "JSON schema for Lassie config files (https://github.com/geprog/lassie-bot-dog)",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "plugins": {
+      "description": "Define configurations for all available plugins",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "auto_merge": {
+          "description": "Configuration for the auto_merge plugin",
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "squash": {
+              "description": "Whether or not to squash the merge request when merging",
+              "type": "boolean"
+            },
+            "neededLabels": {
+              "description": "Labels needed for merge request to be ready for auto merging",
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "minItems": 1,
+              "uniqueItems": true
+            }
+          }
+        }
+      }
+    }
+  }
+}