chore: bring back the "onSetupMessage"

Author: pkosiec

docs/static/schemas/plugin-manifest.schema.json

@@ -86,6 +86,10 @@
       "type": "string",
       "description": "SPDX license identifier",
       "examples": ["Apache-2.0", "MIT"]
+    },
+    "onSetupMessage": {
+      "type": "string",
+      "description": "Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning)."
     }
   },
   "additionalProperties": false,

docs/static/schemas/template-plugins.schema.json

@@ -65,6 +65,10 @@
           "default": false,
           "description": "When true, this plugin is required by the template and cannot be deselected during CLI init. The user will only be prompted to configure its resources. When absent or false, the plugin is optional and the user can choose whether to include it."
         },
+        "onSetupMessage": {
+          "type": "string",
+          "description": "Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning)."
+        },
         "resources": {
           "type": "object",
           "required": ["required", "optional"],

packages/appkit/src/plugins/lakebase/manifest.json

@@ -3,6 +3,7 @@
   "name": "lakebase",
   "displayName": "Lakebase",
   "description": "SQL query execution against Databricks Lakebase Autoscaling",
+  "onSetupMessage": "Configure environment variables before running or deploying the app.\nSee: https://databricks.github.io/appkit/docs/plugins/lakebase",
   "resources": {
     "required": [],
     "optional": []

packages/shared/src/cli/commands/plugin/manifest-types.ts

@@ -27,6 +27,7 @@ export interface PluginManifest {
     optional: ResourceRequirement[];
   };
   config?: { schema: unknown };
+  onSetupMessage?: string;
 }
 
 export interface TemplatePlugin extends Omit<PluginManifest, "config"> {

packages/shared/src/cli/commands/plugin/sync/sync.ts

@@ -278,6 +278,9 @@ function discoverLocalPlugins(
         description: manifest.description,
         package: `./${relativePath}`,
         resources: manifest.resources,
+        ...(manifest.onSetupMessage && {
+          onSetupMessage: manifest.onSetupMessage,
+        }),
       };
     } catch (error) {
       console.warn(
@@ -358,6 +361,9 @@ function scanForPlugins(
         description: manifest.description,
         package: packageName,
         resources: manifest.resources,
+        ...(manifest.onSetupMessage && {
+          onSetupMessage: manifest.onSetupMessage,
+        }),
       };
     }
   }
@@ -400,6 +406,9 @@ function scanPluginsDir(
           description: manifest.description,
           package: packageName,
           resources: manifest.resources,
+          ...(manifest.onSetupMessage && {
+            onSetupMessage: manifest.onSetupMessage,
+          }),
         };
       }
     } catch (error) {

packages/shared/src/plugin.ts

@@ -84,6 +84,7 @@ export interface PluginManifest {
   config?: {
     schema: JSONSchema7;
   };
+  onSetupMessage?: string;
   author?: string;
   version?: string;
   repository?: string;

packages/shared/src/schemas/plugin-manifest.schema.json

@@ -86,6 +86,10 @@
       "type": "string",
       "description": "SPDX license identifier",
       "examples": ["Apache-2.0", "MIT"]
+    },
+    "onSetupMessage": {
+      "type": "string",
+      "description": "Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning)."
     }
   },
   "additionalProperties": false,

packages/shared/src/schemas/template-plugins.schema.json

@@ -65,6 +65,10 @@
           "default": false,
           "description": "When true, this plugin is required by the template and cannot be deselected during CLI init. The user will only be prompted to configure its resources. When absent or false, the plugin is optional and the user can choose whether to include it."
         },
+        "onSetupMessage": {
+          "type": "string",
+          "description": "Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning)."
+        },
         "resources": {
           "type": "object",
           "required": ["required", "optional"],

template/appkit.plugins.json

@@ -34,7 +34,8 @@
       "resources": {
         "required": [],
         "optional": []
-      }
+      },
+      "onSetupMessage": "Configure environment variables before running or deploying the app.\nSee: https://databricks.github.io/appkit/docs/plugins/lakebase"
     },
     "server": {
       "name": "server",