@backstage/plugin-devtools-backend 0.4.0-next.1 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 # @backstage/plugin-devtools-backend
 
+## 0.4.0
+
+### Minor Changes
+
+- d425fc4: **BREAKING**: The return values from `createBackendPlugin`, `createBackendModule`, and `createServiceFactory` are now simply `BackendFeature` and `ServiceFactory`, instead of the previously deprecated form of a function that returns them. For this reason, `createServiceFactory` also no longer accepts the callback form where you provide direct options to the service. This also affects all `coreServices.*` service refs.
+
+  This may in particular affect tests; if you were effectively doing `createBackendModule({...})()` (note the parentheses), you can now remove those extra parentheses at the end. You may encounter cases of this in your `packages/backend/src/index.ts` too, where you add plugins, modules, and services. If you were using `createServiceFactory` with a function as its argument for the purpose of passing in options, this pattern has been deprecated for a while and is no longer supported. You may want to explore the new multiton patterns to achieve your goals, or moving settings to app-config.
+
+  As part of this change, the `IdentityFactoryOptions` type was removed, and can no longer be used to tweak that service. The identity service was also deprecated some time ago, and you will want to [migrate to the new auth system](https://backstage.io/docs/tutorials/auth-service-migration) if you still rely on it.
+
+### Patch Changes
+
+- 5d1670f: Update README installation instructions
+- c2b63ab: Updated dependency `supertest` to `^7.0.0`.
+- Updated dependencies
+  - @backstage/backend-common@0.25.0
+  - @backstage/backend-plugin-api@1.0.0
+  - @backstage/plugin-permission-node@0.8.3
+  - @backstage/config-loader@1.9.1
+  - @backstage/cli-common@0.1.14
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-devtools-common@0.1.12
+  - @backstage/plugin-permission-common@0.8.1
+
+## 0.4.0-next.2
+
+### Patch Changes
+
+- 5d1670f: Update README installation instructions
+- c2b63ab: Updated dependency `supertest` to `^7.0.0`.
+- Updated dependencies
+  - @backstage/backend-common@0.25.0-next.2
+  - @backstage/backend-plugin-api@1.0.0-next.2
+  - @backstage/config-loader@1.9.1-next.0
+  - @backstage/plugin-permission-node@0.8.3-next.2
+  - @backstage/cli-common@0.1.14
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-devtools-common@0.1.12
+  - @backstage/plugin-permission-common@0.8.1
+
 ## 0.4.0-next.1
 
 ### Patch Changes

package/README.md

@@ -4,7 +4,30 @@ Welcome to the DevTools backend plugin! This plugin provides data for the [DevTo
 
 ## Setup
 
-Here's how to get the DevTools Backend up and running:
+Here's how to get the DevTools Backend up and running in the new backend system:
+
+1. First we need to add the `@backstage/plugin-devtools-backend` package to your backend:
+
+   ```sh
+   # From the Backstage root directory
+   yarn --cwd packages/backend add @backstage/plugin-devtools-backend
+   ```
+
+2. Then add the plugin to your backend index file:
+
+   ```ts
+   // In packages/backend/src/index.ts
+   const backend = createBackend();
+   // ... other feature additions
+   backend.add(import('@backstage/plugin-devtools-backend'));
+   ```
+
+3. Now run `yarn start-backend` from the repo root
+4. Finally open `http://localhost:7007/api/devtools/health` in a browser and it should return `{"status":"ok"}`
+
+## Old Backend System
+
+If you are still on the old backend system, please consider migrating to the new backend system. But to install this plugin in an old backend, see below.
 
 1. First we need to add the `@backstage/plugin-devtools-backend` package to your backend:
 
@@ -50,24 +73,6 @@ Here's how to get the DevTools Backend up and running:
 4. Now run `yarn start-backend` from the repo root
 5. Finally open `http://localhost:7007/api/devtools/health` in a browser and it should return `{"status":"ok"}`
 
-### New Backend System
-
-The DevTools backend plugin has support for the [new backend system](https://backstage.io/docs/backend-system/), here's how you can set that up:
-
-In your `packages/backend/src/index.ts` make the following changes:
-
-```diff
-  import { createBackend } from '@backstage/backend-defaults';
-
-  const backend = createBackend();
-
-  // ... other feature additions
-
-+ backend.add(import('@backstage/plugin-devtools-backend'));
-
-  backend.start();
-```
-
 ## Links
 
 - [Frontend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/devtools)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-devtools-backend",
-  "version": "0.4.0-next.1",
+  "version": "0.4.0",
   "backstage": {
     "role": "backend-plugin",
     "pluginId": "devtools",
@@ -38,15 +38,15 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.25.0-next.1",
-    "@backstage/backend-plugin-api": "^0.9.0-next.1",
+    "@backstage/backend-common": "^0.25.0",
+    "@backstage/backend-plugin-api": "^1.0.0",
     "@backstage/cli-common": "^0.1.14",
     "@backstage/config": "^1.2.0",
-    "@backstage/config-loader": "^1.9.0",
+    "@backstage/config-loader": "^1.9.1",
     "@backstage/errors": "^1.2.4",
     "@backstage/plugin-devtools-common": "^0.1.12",
     "@backstage/plugin-permission-common": "^0.8.1",
-    "@backstage/plugin-permission-node": "^0.8.3-next.1",
+    "@backstage/plugin-permission-node": "^0.8.3",
     "@backstage/types": "^1.1.1",
     "@manypkg/get-packages": "^1.1.3",
     "@types/express": "*",
@@ -62,13 +62,13 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "^0.5.0-next.1",
-    "@backstage/backend-test-utils": "^0.6.0-next.1",
-    "@backstage/cli": "^0.27.1-next.1",
+    "@backstage/backend-defaults": "^0.5.0",
+    "@backstage/backend-test-utils": "^1.0.0",
+    "@backstage/cli": "^0.27.1",
     "@types/ping": "^0.4.1",
     "@types/supertest": "^2.0.8",
     "@types/yarnpkg__lockfile": "^1.1.4",
-    "supertest": "^6.2.4"
+    "supertest": "^7.0.0"
   },
   "configSchema": "config.d.ts"
 }