Skip to content

Commit

Permalink
fix(config): add descriptions to JSON schema properties
Browse files Browse the repository at this point in the history
  • Loading branch information
Keyrxng committed Nov 26, 2024
1 parent 9c8df86 commit 69c1ced
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/types/plugin-input.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {} }
);
Expand All @@ -31,16 +31,16 @@ 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" }),
/**
* Repositories to ignore updates from
*/
ignore: T.Array(T.String(), { default: [] }),
ignore: T.Array(T.String(), { default: [], description: "Repositories to ignore updates from" }),
},
{ 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." });

export const pluginSettingsSchema = T.Object({
approvalsRequired: T.Optional(approvalsRequiredSchema),
Expand Down

0 comments on commit 69c1ced

Please sign in to comment.