@backstage/plugin-devtools 0.0.0-nightly-20260315031533 → 0.0.0-nightly-20260317031259

package/CHANGELOG.md

@@ -1,20 +1,22 @@
 # @backstage/plugin-devtools
 
-## 0.0.0-nightly-20260315031533
+## 0.0.0-nightly-20260317031259
 
 ### Patch Changes
 
 - afabb37: Fixed URL encoding of task IDs for the trigger feature (tasks that contained a "/" in their ID were not triggered)
 - f80195e: Added `cancelScheduledTask` to the DevTools API and a cancel button to the scheduled tasks UI.
-- Updated dependencies
-  - @backstage/core-compat-api@0.0.0-nightly-20260315031533
-  - @backstage/frontend-plugin-api@0.0.0-nightly-20260315031533
-  - @backstage/plugin-devtools-common@0.0.0-nightly-20260315031533
-  - @backstage/core-plugin-api@0.0.0-nightly-20260315031533
-  - @backstage/core-components@0.0.0-nightly-20260315031533
+- 538c985: Updated installation documentation to use feature discovery as the default.
+- 3f36ce1: Updated alpha plugin icons to follow the new frontend icon sizing rules when rendered in plugin and navigation surfaces.
+- Updated dependencies
+  - @backstage/core-compat-api@0.0.0-nightly-20260317031259
+  - @backstage/core-components@0.0.0-nightly-20260317031259
+  - @backstage/frontend-plugin-api@0.0.0-nightly-20260317031259
+  - @backstage/plugin-devtools-common@0.0.0-nightly-20260317031259
+  - @backstage/core-plugin-api@0.0.0-nightly-20260317031259
+  - @backstage/plugin-devtools-react@0.0.0-nightly-20260317031259
   - @backstage/errors@1.2.7
-  - @backstage/plugin-devtools-react@0.0.0-nightly-20260315031533
-  - @backstage/plugin-permission-react@0.0.0-nightly-20260315031533
+  - @backstage/plugin-permission-react@0.0.0-nightly-20260317031259
 
 ## 0.1.37-next.2
 

package/README.md

@@ -66,42 +66,14 @@ You need to setup the [DevTools backend plugin](../devtools-backend/README.md) b
 
 ### Frontend
 
-To setup the DevTools frontend you'll need to do the following steps:
+Install the `@backstage/plugin-devtools` package in your frontend app:
 
-1. First we need to add the `@backstage/plugin-devtools` package to your frontend app:
-
-   ```sh
-   # From your Backstage root directory
-   yarn --cwd packages/app add @backstage/plugin-devtools
-   ```
-
-2. Now open the `packages/app/src/App.tsx` file
-3. Then after all the import statements add the following line:
-
-   ```ts
-   import { DevToolsPage } from '@backstage/plugin-devtools';
-   ```
-
-4. In this same file just before the closing `</ FlatRoutes>`, this will be near the bottom of the file, add this line:
-
-   ```ts
-   <Route path="/devtools" element={<DevToolsPage />} />
-   ```
-
-5. Next open the `packages/app/src/components/Root/Root.tsx` file
-6. We want to add this icon import after all the existing import statements:
-
-   ```ts
-   import BuildIcon from '@material-ui/icons/Build';
-   ```
-
-7. Then add this line just after the `<SidebarSettings />` line:
-
-   ```ts
-   <SidebarItem icon={BuildIcon} to="devtools" text="DevTools" />
-   ```
+```sh
+# From your Backstage root directory
+yarn --cwd packages/app add @backstage/plugin-devtools
+```
 
-8. Now run `yarn start` from the root of your project and you should see the DevTools option show up just below Settings in your sidebar and clicking on it will get you to the [Info tab](#info)
+Once installed, the plugin is automatically available in your app through the default feature discovery. For more details and alternative installation methods, see [installing plugins](https://backstage.io/docs/frontend-system/building-apps/installing-plugins).
 
 ## Customizing
 
@@ -166,8 +138,6 @@ You can also add tabs to show content from other plugins that fit well with the
 
 #### Catalog Unprocessed Entities Tab
 
-##### New Frontend System
-
 Create an extension and/or load a 3rd party extension to add additional tabs.
 
 ```shell
@@ -197,7 +167,7 @@ const appFeature = createFrontendModule({
 });
 ```
 
-##### Old System
+##### Old Frontend System
 
 Here's how to add the Catalog Unprocessed Entities tab:
 
@@ -230,6 +200,38 @@ Here's how to add the Catalog Unprocessed Entities tab:
 
 4. Now run `yarn start` and navigate to the DevTools you'll see a new tab for Unprocessed Entities
 
+## Old Frontend System
+
+If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app as outlined in this section. If you are on the new frontend system, you can skip this.
+
+1. Open the `packages/app/src/App.tsx` file
+2. Then after all the import statements add the following line:
+
+   ```ts
+   import { DevToolsPage } from '@backstage/plugin-devtools';
+   ```
+
+3. In this same file just before the closing `</FlatRoutes>`, this will be near the bottom of the file, add this line:
+
+   ```ts
+   <Route path="/devtools" element={<DevToolsPage />} />
+   ```
+
+4. Next open the `packages/app/src/components/Root/Root.tsx` file
+5. We want to add this icon import after all the existing import statements:
+
+   ```ts
+   import BuildIcon from '@material-ui/icons/Build';
+   ```
+
+6. Then add this line just after the `<SidebarSettings />` line:
+
+   ```ts
+   <SidebarItem icon={BuildIcon} to="devtools" text="DevTools" />
+   ```
+
+7. Now run `yarn start` from the root of your project and you should see the DevTools option show up just below Settings in your sidebar and clicking on it will get you to the [Info tab](#info)
+
 ## Permissions
 
 The DevTools plugin supports the [permissions framework](https://backstage.io/docs/permissions/overview), the following sections outline how you can use them with the assumption that you have the permissions framework setup and working.

package/dist/alpha/plugin.esm.js

@@ -54,7 +54,7 @@ const devToolsNavItem = NavItemBlueprint.make({
 var plugin = createFrontendPlugin({
   pluginId: "devtools",
   title: "DevTools",
-  icon: /* @__PURE__ */ jsx(BuildIcon, {}),
+  icon: /* @__PURE__ */ jsx(BuildIcon, { fontSize: "inherit" }),
   info: { packageJson: () => import('../package.json.esm.js') },
   routes: {
     root: rootRouteRef

package/dist/alpha/plugin.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.esm.js","sources":["../../src/alpha/plugin.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createFrontendPlugin,\n  discoveryApiRef,\n  fetchApiRef,\n  ApiBlueprint,\n  PageBlueprint,\n  NavItemBlueprint,\n  createExtensionInput,\n  coreExtensionData,\n} from '@backstage/frontend-plugin-api';\n\nimport { devToolsApiRef, DevToolsClient } from '../api';\nimport BuildIcon from '@material-ui/icons/Build';\nimport { rootRouteRef } from '../routes';\n\n/** @alpha */\nexport const devToolsApi = ApiBlueprint.make({\n  params: defineParams =>\n    defineParams({\n      api: devToolsApiRef,\n      deps: {\n        discoveryApi: discoveryApiRef,\n        fetchApi: fetchApiRef,\n      },\n      factory: ({ discoveryApi, fetchApi }) =>\n        new DevToolsClient({ discoveryApi, fetchApi }),\n    }),\n});\n\n/** @alpha */\nexport const devToolsPage = PageBlueprint.makeWithOverrides({\n  inputs: {\n    contents: createExtensionInput(\n      [\n        coreExtensionData.reactElement,\n        coreExtensionData.routePath,\n        coreExtensionData.routeRef.optional(),\n        coreExtensionData.title,\n      ],\n      {\n        optional: true,\n      },\n    ),\n  },\n  factory(originalFactory, { inputs }) {\n    return originalFactory({\n      path: '/devtools',\n      routeRef: rootRouteRef,\n      loader: () => {\n        const contents = inputs.contents.map(content => ({\n          path: content.get(coreExtensionData.routePath),\n          title: content.get(coreExtensionData.title),\n          children: content.get(coreExtensionData.reactElement),\n        }));\n        return import('../components/DevToolsPage').then(m => (\n          <m.DevToolsPage contents={contents} />\n        ));\n      },\n    });\n  },\n});\n\n/** @alpha */\nexport const devToolsNavItem = NavItemBlueprint.make({\n  params: {\n    title: 'DevTools',\n    routeRef: rootRouteRef,\n    icon: BuildIcon,\n  },\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n  pluginId: 'devtools',\n  title: 'DevTools',\n  icon: <BuildIcon />,\n  info: { packageJson: () => import('../../package.json') },\n  routes: {\n    root: rootRouteRef,\n  },\n  extensions: [devToolsApi, devToolsPage, devToolsNavItem],\n});\n"],"names":[],"mappings":";;;;;;;AAgCO,MAAM,WAAA,GAAc,aAAa,IAAA,CAAK;AAAA,EAC3C,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,cAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,YAAA,EAAc,eAAA;AAAA,MACd,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,YAAA,EAAc,QAAA,EAAS,KACjC,IAAI,cAAA,CAAe,EAAE,YAAA,EAAc,QAAA,EAAU;AAAA,GAChD;AACL,CAAC;AAGM,MAAM,YAAA,GAAe,cAAc,iBAAA,CAAkB;AAAA,EAC1D,MAAA,EAAQ;AAAA,IACN,QAAA,EAAU,oBAAA;AAAA,MACR;AAAA,QACE,iBAAA,CAAkB,YAAA;AAAA,QAClB,iBAAA,CAAkB,SAAA;AAAA,QAClB,iBAAA,CAAkB,SAAS,QAAA,EAAS;AAAA,QACpC,iBAAA,CAAkB;AAAA,OACpB;AAAA,MACA;AAAA,QACE,QAAA,EAAU;AAAA;AACZ;AACF,GACF;AAAA,EACA,OAAA,CAAQ,eAAA,EAAiB,EAAE,MAAA,EAAO,EAAG;AACnC,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,WAAA;AAAA,MACN,QAAA,EAAU,YAAA;AAAA,MACV,QAAQ,MAAM;AACZ,QAAA,MAAM,QAAA,GAAW,MAAA,CAAO,QAAA,CAAS,GAAA,CAAI,CAAA,OAAA,MAAY;AAAA,UAC/C,IAAA,EAAM,OAAA,CAAQ,GAAA,CAAI,iBAAA,CAAkB,SAAS,CAAA;AAAA,UAC7C,KAAA,EAAO,OAAA,CAAQ,GAAA,CAAI,iBAAA,CAAkB,KAAK,CAAA;AAAA,UAC1C,QAAA,EAAU,OAAA,CAAQ,GAAA,CAAI,iBAAA,CAAkB,YAAY;AAAA,SACtD,CAAE,CAAA;AACF,QAAA,OAAO,OAAO,yCAA4B,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,yBAC9C,CAAA,CAAE,YAAA,EAAF,EAAe,QAAA,EAAoB,CACrC,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;AAGM,MAAM,eAAA,GAAkB,iBAAiB,IAAA,CAAK;AAAA,EACnD,MAAA,EAAQ;AAAA,IACN,KAAA,EAAO,UAAA;AAAA,IACP,QAAA,EAAU,YAAA;AAAA,IACV,IAAA,EAAM;AAAA;AAEV,CAAC;AAGD,aAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,UAAA;AAAA,EACV,KAAA,EAAO,UAAA;AAAA,EACP,IAAA,sBAAO,SAAA,EAAA,EAAU,CAAA;AAAA,EACjB,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,wBAAoB,CAAA,EAAE;AAAA,EACxD,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA,GACR;AAAA,EACA,UAAA,EAAY,CAAC,WAAA,EAAa,YAAA,EAAc,eAAe;AACzD,CAAC,CAAA;;;;"}
+{"version":3,"file":"plugin.esm.js","sources":["../../src/alpha/plugin.tsx"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createFrontendPlugin,\n  discoveryApiRef,\n  fetchApiRef,\n  ApiBlueprint,\n  PageBlueprint,\n  NavItemBlueprint,\n  createExtensionInput,\n  coreExtensionData,\n} from '@backstage/frontend-plugin-api';\n\nimport { devToolsApiRef, DevToolsClient } from '../api';\nimport BuildIcon from '@material-ui/icons/Build';\nimport { rootRouteRef } from '../routes';\n\n/** @alpha */\nexport const devToolsApi = ApiBlueprint.make({\n  params: defineParams =>\n    defineParams({\n      api: devToolsApiRef,\n      deps: {\n        discoveryApi: discoveryApiRef,\n        fetchApi: fetchApiRef,\n      },\n      factory: ({ discoveryApi, fetchApi }) =>\n        new DevToolsClient({ discoveryApi, fetchApi }),\n    }),\n});\n\n/** @alpha */\nexport const devToolsPage = PageBlueprint.makeWithOverrides({\n  inputs: {\n    contents: createExtensionInput(\n      [\n        coreExtensionData.reactElement,\n        coreExtensionData.routePath,\n        coreExtensionData.routeRef.optional(),\n        coreExtensionData.title,\n      ],\n      {\n        optional: true,\n      },\n    ),\n  },\n  factory(originalFactory, { inputs }) {\n    return originalFactory({\n      path: '/devtools',\n      routeRef: rootRouteRef,\n      loader: () => {\n        const contents = inputs.contents.map(content => ({\n          path: content.get(coreExtensionData.routePath),\n          title: content.get(coreExtensionData.title),\n          children: content.get(coreExtensionData.reactElement),\n        }));\n        return import('../components/DevToolsPage').then(m => (\n          <m.DevToolsPage contents={contents} />\n        ));\n      },\n    });\n  },\n});\n\n/** @alpha */\nexport const devToolsNavItem = NavItemBlueprint.make({\n  params: {\n    title: 'DevTools',\n    routeRef: rootRouteRef,\n    icon: BuildIcon,\n  },\n});\n\n/** @alpha */\nexport default createFrontendPlugin({\n  pluginId: 'devtools',\n  title: 'DevTools',\n  icon: <BuildIcon fontSize=\"inherit\" />,\n  info: { packageJson: () => import('../../package.json') },\n  routes: {\n    root: rootRouteRef,\n  },\n  extensions: [devToolsApi, devToolsPage, devToolsNavItem],\n});\n"],"names":[],"mappings":";;;;;;;AAgCO,MAAM,WAAA,GAAc,aAAa,IAAA,CAAK;AAAA,EAC3C,MAAA,EAAQ,kBACN,YAAA,CAAa;AAAA,IACX,GAAA,EAAK,cAAA;AAAA,IACL,IAAA,EAAM;AAAA,MACJ,YAAA,EAAc,eAAA;AAAA,MACd,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,OAAA,EAAS,CAAC,EAAE,YAAA,EAAc,QAAA,EAAS,KACjC,IAAI,cAAA,CAAe,EAAE,YAAA,EAAc,QAAA,EAAU;AAAA,GAChD;AACL,CAAC;AAGM,MAAM,YAAA,GAAe,cAAc,iBAAA,CAAkB;AAAA,EAC1D,MAAA,EAAQ;AAAA,IACN,QAAA,EAAU,oBAAA;AAAA,MACR;AAAA,QACE,iBAAA,CAAkB,YAAA;AAAA,QAClB,iBAAA,CAAkB,SAAA;AAAA,QAClB,iBAAA,CAAkB,SAAS,QAAA,EAAS;AAAA,QACpC,iBAAA,CAAkB;AAAA,OACpB;AAAA,MACA;AAAA,QACE,QAAA,EAAU;AAAA;AACZ;AACF,GACF;AAAA,EACA,OAAA,CAAQ,eAAA,EAAiB,EAAE,MAAA,EAAO,EAAG;AACnC,IAAA,OAAO,eAAA,CAAgB;AAAA,MACrB,IAAA,EAAM,WAAA;AAAA,MACN,QAAA,EAAU,YAAA;AAAA,MACV,QAAQ,MAAM;AACZ,QAAA,MAAM,QAAA,GAAW,MAAA,CAAO,QAAA,CAAS,GAAA,CAAI,CAAA,OAAA,MAAY;AAAA,UAC/C,IAAA,EAAM,OAAA,CAAQ,GAAA,CAAI,iBAAA,CAAkB,SAAS,CAAA;AAAA,UAC7C,KAAA,EAAO,OAAA,CAAQ,GAAA,CAAI,iBAAA,CAAkB,KAAK,CAAA;AAAA,UAC1C,QAAA,EAAU,OAAA,CAAQ,GAAA,CAAI,iBAAA,CAAkB,YAAY;AAAA,SACtD,CAAE,CAAA;AACF,QAAA,OAAO,OAAO,yCAA4B,CAAA,CAAE,IAAA,CAAK,CAAA,CAAA,yBAC9C,CAAA,CAAE,YAAA,EAAF,EAAe,QAAA,EAAoB,CACrC,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;AAGM,MAAM,eAAA,GAAkB,iBAAiB,IAAA,CAAK;AAAA,EACnD,MAAA,EAAQ;AAAA,IACN,KAAA,EAAO,UAAA;AAAA,IACP,QAAA,EAAU,YAAA;AAAA,IACV,IAAA,EAAM;AAAA;AAEV,CAAC;AAGD,aAAe,oBAAA,CAAqB;AAAA,EAClC,QAAA,EAAU,UAAA;AAAA,EACV,KAAA,EAAO,UAAA;AAAA,EACP,IAAA,kBAAM,GAAA,CAAC,SAAA,EAAA,EAAU,QAAA,EAAS,SAAA,EAAU,CAAA;AAAA,EACpC,MAAM,EAAE,WAAA,EAAa,MAAM,OAAO,wBAAoB,CAAA,EAAE;AAAA,EACxD,MAAA,EAAQ;AAAA,IACN,IAAA,EAAM;AAAA,GACR;AAAA,EACA,UAAA,EAAY,CAAC,WAAA,EAAa,YAAA,EAAc,eAAe;AACzD,CAAC,CAAA;;;;"}

package/dist/package.json.esm.js

@@ -1,5 +1,5 @@
 var name = "@backstage/plugin-devtools";
-var version = "0.0.0-nightly-20260315031533";
+var version = "0.0.0-nightly-20260317031259";
 var backstage = {
 	role: "frontend-plugin",
 	pluginId: "devtools",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-devtools",
-  "version": "0.0.0-nightly-20260315031533",
+  "version": "0.0.0-nightly-20260317031259",
   "backstage": {
     "role": "frontend-plugin",
     "pluginId": "devtools",
@@ -65,14 +65,14 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-compat-api": "0.0.0-nightly-20260315031533",
-    "@backstage/core-components": "0.0.0-nightly-20260315031533",
-    "@backstage/core-plugin-api": "0.0.0-nightly-20260315031533",
+    "@backstage/core-compat-api": "0.0.0-nightly-20260317031259",
+    "@backstage/core-components": "0.0.0-nightly-20260317031259",
+    "@backstage/core-plugin-api": "0.0.0-nightly-20260317031259",
     "@backstage/errors": "1.2.7",
-    "@backstage/frontend-plugin-api": "0.0.0-nightly-20260315031533",
-    "@backstage/plugin-devtools-common": "0.0.0-nightly-20260315031533",
-    "@backstage/plugin-devtools-react": "0.0.0-nightly-20260315031533",
-    "@backstage/plugin-permission-react": "0.0.0-nightly-20260315031533",
+    "@backstage/frontend-plugin-api": "0.0.0-nightly-20260317031259",
+    "@backstage/plugin-devtools-common": "0.0.0-nightly-20260317031259",
+    "@backstage/plugin-devtools-react": "0.0.0-nightly-20260317031259",
+    "@backstage/plugin-permission-react": "0.0.0-nightly-20260317031259",
     "@material-ui/core": "^4.9.13",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "^4.0.0-alpha.57",
@@ -81,8 +81,8 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/cli": "0.0.0-nightly-20260315031533",
-    "@backstage/dev-utils": "0.0.0-nightly-20260315031533",
+    "@backstage/cli": "0.0.0-nightly-20260317031259",
+    "@backstage/dev-utils": "0.0.0-nightly-20260317031259",
     "@testing-library/jest-dom": "^6.0.0",
     "@types/lodash": "^4.14.151",
     "@types/react": "^18.0.0",