@backstage/plugin-scaffolder-node 0.13.6 → 0.13.7-next.1

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @backstage/plugin-scaffolder-node
 
+## 0.13.7-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-scaffolder-common@2.3.0-next.1
+  - @backstage/integration@2.1.2-next.0
+  - @backstage/backend-test-utils@1.11.7-next.0
+  - @backstage/plugin-permission-node@0.11.4-next.0
+  - @backstage/backend-plugin-api@1.10.1-next.0
+
+## 0.13.7-next.0
+
+### Patch Changes
+
+- e95b649: Added task recovery feature with new `scaffolder.taskRecovery` config section. When enabled, tasks that crash or timeout are automatically recovered and resume from the last completed step, task secrets are retained until the task reaches a terminal state so recovery can continue, and completed step outputs are persisted. Enabling recovery applies to all scaffolder tasks, so actions used by those tasks should be idempotent or use checkpoints. When recovery is disabled (the default), the previous behavior is unchanged: secrets are cleared as soon as a task is claimed and retries re-run every step. The new config consolidates previous experimental flags (`EXPERIMENTAL_recoverTasks`, `EXPERIMENTAL_workspaceSerialization`, `EXPERIMENTAL_recoverTasksTimeout`) which remain supported as fallbacks. The legacy workspace provider setting continues to select a provider only when `EXPERIMENTAL_workspaceSerialization` is `true`.
+
+  Workspace serialization for task recovery now requires installing a separate workspace provider module, including when you use the legacy configuration. For development, use `@backstage/plugin-scaffolder-backend-module-workspace-database` (50 MB limit, not recommended for production). On first startup, that module migrates existing database workspace snapshots from the legacy task storage. For production, use `@backstage/plugin-scaffolder-backend-module-gcp` or a similar external storage provider. The scaffolder rejects a configured provider that has not been installed and registered.
+
+  Enabling crash recovery does not keep completed task event streams open; normal task completion remains terminal for event-stream clients.
+
+- Updated dependencies
+  - @backstage/plugin-scaffolder-common@2.3.0-next.0
+
 ## 0.13.6
 
 ### Patch Changes

package/dist/alpha.d.ts

@@ -140,6 +140,8 @@ type CheckpointState = {
 /**
  * Context for checkpoint function invocation.
  *
+ * The value returned by `fn` will be serialized to JSON for storage.
+ *
  * @alpha
  */
 type CheckpointContext<T extends JsonValue | void = JsonValue> = {
@@ -148,7 +150,8 @@ type CheckpointContext<T extends JsonValue | void = JsonValue> = {
      */
     key: string;
     /**
-     * Function to execute for the checkpoint
+     * Function to execute for the checkpoint.
+     * The return value will be JSON-serialized for storage.
      */
     fn: () => Promise<T> | T;
 };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { JsonObject, Observable, JsonValue, Expand } from '@backstage/types';
+import { JsonObject, JsonValue, Observable, Expand } from '@backstage/types';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { BackstageCredentials, LoggerService, UrlReaderService } from '@backstage/backend-plugin-api';
 import { PermissionCriteria } from '@backstage/plugin-permission-common';
@@ -157,6 +157,13 @@ interface TaskContext {
         taskId: string;
         targetPath: string;
     }): Promise<void>;
+    updateStepState?(options: {
+        stepId: string;
+        status: 'completed';
+        output: {
+            [name: string]: JsonValue;
+        };
+    }): Promise<void>;
     getWorkspaceName(): Promise<string>;
     getInitiatorCredentials(): Promise<BackstageCredentials>;
 }
@@ -215,6 +222,10 @@ type ActionContext<TActionInput extends JsonObject, TActionOutput extends JsonOb
     secrets?: TaskSecrets;
     workspacePath: string;
     input: TActionInput;
+    /**
+     * Execute a function with checkpoint support for recovery.
+     * The return value is serialized to JSON for storage.
+     */
     checkpoint<T extends JsonValue | void>(opts: CheckpointContext<T>): Promise<T>;
     output(name: keyof TActionOutput, value: TActionOutput[keyof TActionOutput]): void;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-node",
-  "version": "0.13.6",
+  "version": "0.13.7-next.1",
   "description": "The plugin-scaffolder-node module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "node-library",
@@ -70,14 +70,14 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.10.0",
-    "@backstage/catalog-model": "^1.10.0",
-    "@backstage/errors": "^1.3.1",
-    "@backstage/integration": "^2.1.0",
-    "@backstage/plugin-permission-common": "^0.9.10",
-    "@backstage/plugin-permission-node": "^0.11.3",
-    "@backstage/plugin-scaffolder-common": "^2.2.2",
-    "@backstage/types": "^1.2.2",
+    "@backstage/backend-plugin-api": "1.10.1-next.0",
+    "@backstage/catalog-model": "1.10.0",
+    "@backstage/errors": "1.3.1",
+    "@backstage/integration": "2.1.2-next.0",
+    "@backstage/plugin-permission-common": "0.9.10",
+    "@backstage/plugin-permission-node": "0.11.4-next.0",
+    "@backstage/plugin-scaffolder-common": "2.3.0-next.1",
+    "@backstage/types": "1.2.2",
     "@isomorphic-git/pgp-plugin": "^0.0.7",
     "concat-stream": "^2.0.0",
     "fs-extra": "^11.2.0",
@@ -93,14 +93,14 @@
     "zod-to-json-schema": "^3.25.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.11.6",
-    "@backstage/cli": "^0.36.5",
-    "@backstage/config": "^1.3.8",
+    "@backstage/backend-test-utils": "1.11.7-next.0",
+    "@backstage/cli": "0.36.6-next.0",
+    "@backstage/config": "1.3.8",
     "@types/lodash": "^4.14.151",
     "msw": "^2.0.0"
   },
   "peerDependencies": {
-    "@backstage/backend-test-utils": "^1.11.6"
+    "@backstage/backend-test-utils": "1.11.7-next.0"
   },
   "peerDependenciesMeta": {
     "@backstage/backend-test-utils": {