Merge pull request #30 from ubq-testing/development

fix(config): add descriptions to JSON schema properties
ubiquity-os-marketplace · Nov 29, 2024 · 4298993 · 4298993
2 parents 0004a4b + 18f3254
commit 4298993
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 7 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/manifest.json b/manifest.json
@@ -12,11 +12,13 @@
           "collaborator": {
             "default": 1,
             "minimum": 1,
+            "description": "The amount of validations needed to consider a pull-request by a collaborator to be deemed eligible for merge",
             "type": "number"
           },
           "contributor": {
             "default": 2,
             "minimum": 1,
+            "description": "The amount of validations needed to consider a pull-request by a contributor to be deemed eligible for merge",
             "type": "number"
           }
         }
@@ -28,6 +30,7 @@
           "collaborator": {
             "default": "3.5 days",
             "description": "The timespan to wait before merging a collaborator's pull-request",
+            "examples": ["1 day", "3.5 days"],
             "type": "string"
           }
         }
@@ -38,6 +41,8 @@
         "properties": {
           "monitor": {
             "default": [],
+            "description": "Repositories to watch for updates, if empty all are watched and if just owner is provided all repositories from that owner are watched.",
+            "examples": ["owner/repo", "owner"],
             "type": "array",
             "items": {
               "minLength": 1,
@@ -46,6 +51,8 @@
           },
           "ignore": {
             "default": [],
+            "description": "Repositories to ignore updates from, if empty all repositories are watched and if just owner is provided all repositories from that owner are ignored",
+            "examples": ["owner/repo", "owner"],
             "type": "array",
             "items": {
               "type": "string"
@@ -55,6 +62,11 @@
       },
       "allowedReviewerRoles": {
         "default": ["COLLABORATOR", "MEMBER", "OWNER"],
+        "description": "When considering a user for a task: which roles should be considered as having review authority? All others are ignored.",
+        "examples": [
+          ["COLLABORATOR", "MEMBER", "OWNER"],
+          ["MEMBER", "OWNER"]
+        ],
         "type": "array",
         "items": {
           "type": "string"

diff --git a/src/types/plugin-input.ts b/src/types/plugin-input.ts
@@ -6,12 +6,12 @@ export const approvalsRequiredSchema = T.Object(
      * The amount of validations needed to consider a pull-request by a collaborator to be deemed eligible for
      * merge, defaults to 1.
      */
-    collaborator: T.Number({ default: 1, minimum: 1 }),
+    collaborator: T.Number({ default: 1, minimum: 1, description: "The amount of validations needed to consider a pull-request by a collaborator to be deemed eligible for merge" }),
     /**
      * The amount of validations needed to consider a pull-request by a contributor to be deemed eligible for merge,
      * defaults to 2.
      */
-    contributor: T.Number({ default: 2, minimum: 1 }),
+    contributor: T.Number({ default: 2, minimum: 1, description: "The amount of validations needed to consider a pull-request by a contributor to be deemed eligible for merge" }),
   },
   { default: {} }
 );
@@ -21,7 +21,11 @@ export const mergeTimeoutSchema = T.Object(
     /**
      * The timespan to wait before merging a collaborator's pull-request, defaults to 3.5 days.
      */
-    collaborator: T.String({ default: "3.5 days", description: "The timespan to wait before merging a collaborator's pull-request" }),
+    collaborator: T.String({
+      default: "3.5 days",
+      description: "The timespan to wait before merging a collaborator's pull-request",
+      examples: ["1 day", "3.5 days"]
+    }),
   },
   { default: {} }
 );
@@ -31,16 +35,28 @@ export const reposSchema = T.Object(
     /**
      * Repositories to watch for updates
      */
-    monitor: T.Array(T.String({ minLength: 1 }), { default: [] }),
+    monitor: T.Array(T.String({ minLength: 1 }), {
+      default: [],
+      description: "Repositories to watch for updates, if empty all are watched and if just owner is provided all repositories from that owner are watched.",
+      examples: ["owner/repo", "owner"]
+    }),
     /**
      * Repositories to ignore updates from
      */
-    ignore: T.Array(T.String(), { default: [] }),
+    ignore: T.Array(T.String(), {
+      default: [],
+      description: "Repositories to ignore updates from, if empty all repositories are watched and if just owner is provided all repositories from that owner are ignored",
+      examples: ["owner/repo", "owner"]
+    }),
   },
   { default: {} }
 );
 
-const allowedReviewerRoles = T.Array(T.String(), { default: ["COLLABORATOR", "MEMBER", "OWNER"] });
+const allowedReviewerRoles = T.Array(T.String(), {
+  default: ["COLLABORATOR", "MEMBER", "OWNER"],
+  description: "When considering a user for a task: which roles should be considered as having review authority? All others are ignored.",
+  examples: [["COLLABORATOR", "MEMBER", "OWNER"], ["MEMBER", "OWNER"]]
+});
 
 export const pluginSettingsSchema = T.Object({
   approvalsRequired: T.Optional(approvalsRequiredSchema),