From 2bf3ad4ce56f6ddecc20e6d2386be44d1485d658 Mon Sep 17 00:00:00 2001 From: Alan Crosswell Date: Mon, 1 Feb 2021 11:45:38 -0500 Subject: [PATCH] better document the config options --- plugins/scaffolder-backend/config.d.ts | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/plugins/scaffolder-backend/config.d.ts b/plugins/scaffolder-backend/config.d.ts index 55ed959edc..3b31b4f951 100644 --- a/plugins/scaffolder-backend/config.d.ts +++ b/plugins/scaffolder-backend/config.d.ts @@ -19,11 +19,17 @@ export interface Config { scaffolder?: { github?: { [key: string]: string; - visiblity?: string; + /** + * The visibility to set on created repositories. + */ + visiblity?: 'public' | 'internal' | 'private'; }; gitlab?: { api: { [key: string]: string }; - visiblity?: string; + /** + * The visibility to set on created repositories. + */ + visiblity?: 'public' | 'internal' | 'private'; }; azure?: { baseUrl: string; @@ -31,7 +37,10 @@ export interface Config { }; bitbucket?: { api: { [key: string]: string }; - visiblity?: string; + /** + * The visibility to set on created repositories. + */ + visiblity?: 'public' | 'private'; }; }; }