Checkpoint

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>

plugins/scaffolder-node/src/actions/types.ts

@@ -35,6 +35,10 @@ export type ActionContext<
   secrets?: TaskSecrets;
   workspacePath: string;
   input: TActionInput;
+  checkpoint?<U extends JsonObject>(
+    key: string,
+    fn: () => Promise<U>,
+  ): Promise<U>;
   output(
     name: keyof TActionOutput,
     value: TActionOutput[keyof TActionOutput],

plugins/scaffolder-node/src/tasks/index.ts

@@ -24,5 +24,6 @@ export type {
   TaskCompletionState,
   TaskContext,
   TaskEventType,
+  TaskState,
   TaskStatus,
 } from './types';

plugins/scaffolder-node/src/tasks/types.ts

@@ -26,6 +26,13 @@ export type TaskSecrets = Record<string, string> & {
   backstageToken?: string;
 };
 
+/**
+ * TaskState
+ *
+ * @public
+ */
+export type TaskState = Record<string, JsonObject>;
+
 /**
  * The status of each step of the Task
  *
@@ -110,6 +117,7 @@ export interface TaskContext {
   cancelSignal: AbortSignal;
   spec: TaskSpec;
   secrets?: TaskSecrets;
+  state?: TaskState;
   createdBy?: string;
   done: boolean;
   isDryRun?: boolean;
@@ -118,6 +126,8 @@ export interface TaskContext {
 
   emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
 
+  updateCheckpoint?(key: string, value: JsonObject): Promise<void>;
+
   getWorkspaceName(): Promise<string>;
 }