@backstage/plugin-scaffolder-backend 1.22.5-next.1 → 1.22.6-next.2

package/dist/index.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var router = require('./cjs/router-DClM_ren.cjs.js');
+var router = require('./cjs/router-DhoUgDz0.cjs.js');
 var github = require('@backstage/plugin-scaffolder-backend-module-github');
 var gitlab = require('@backstage/plugin-scaffolder-backend-module-gitlab');
 var azure = require('@backstage/plugin-scaffolder-backend-module-azure');
@@ -31,12 +31,15 @@ require('isolated-vm');
 require('lodash/get');
 require('@backstage/plugin-scaffolder-backend-module-gitea');
 require('uuid');
+require('tar');
+require('concat-stream');
+require('util');
+require('stream');
 require('zen-observable');
 require('lodash');
 require('p-queue');
 require('winston');
 require('nunjucks');
-require('stream');
 require('@backstage/plugin-permission-node');
 require('prom-client');
 require('@backstage/plugin-permission-common');

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/scaffolder/actions/deprecated.ts","../src/deprecated.ts"],"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 */\nimport * as github from '@backstage/plugin-scaffolder-backend-module-github';\nimport * as gitlab from '@backstage/plugin-scaffolder-backend-module-gitlab';\nimport * as azure from '@backstage/plugin-scaffolder-backend-module-azure';\nimport * as bitbucket from '@backstage/plugin-scaffolder-backend-module-bitbucket';\nimport * as bitbucketCloud from '@backstage/plugin-scaffolder-backend-module-bitbucket-cloud';\nimport * as bitbucketServer from '@backstage/plugin-scaffolder-backend-module-bitbucket-server';\nimport * as gerrit from '@backstage/plugin-scaffolder-backend-module-gerrit';\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubActionsDispatchAction =\n  github.createGithubActionsDispatchAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubDeployKeyAction = github.createGithubDeployKeyAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubEnvironmentAction =\n  github.createGithubEnvironmentAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubIssuesLabelAction =\n  github.createGithubIssuesLabelAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport type CreateGithubPullRequestActionOptions =\n  github.CreateGithubPullRequestActionOptions;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubRepoCreateAction = github.createGithubRepoCreateAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubRepoPushAction = github.createGithubRepoPushAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubWebhookAction = github.createGithubWebhookAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createPublishGithubAction = github.createPublishGithubAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createPublishGithubPullRequestAction =\n  github.createPublishGithubPullRequestAction;\n\n/**\n * @public @deprecated use \"createPublishBitbucketCloudAction\" from \\@backstage/plugin-scaffolder-backend-module-bitbucket-cloud or \"createPublishBitbucketServerAction\" from \\@backstage/plugin-scaffolder-backend-module-bitbucket-server instead\n */\nexport const createPublishBitbucketAction =\n  bitbucket.createPublishBitbucketAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-bitbucket-cloud instead\n */\nexport const createPublishBitbucketCloudAction =\n  bitbucketCloud.createPublishBitbucketCloudAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-bitbucket-server instead\n */\nexport const createPublishBitbucketServerAction =\n  bitbucketServer.createPublishBitbucketServerAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-bitbucket-server instead\n */\nexport const createPublishBitbucketServerPullRequestAction =\n  bitbucketServer.createPublishBitbucketServerPullRequestAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-azure instead\n */\nexport const createPublishAzureAction = azure.createPublishAzureAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-gerrit instead\n */\nexport const createPublishGerritAction = gerrit.createPublishGerritAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-gerrit instead\n */\nexport const createPublishGerritReviewAction =\n  gerrit.createPublishGerritReviewAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-gitlab instead\n */\nexport const createPublishGitlabAction = gitlab.createPublishGitlabAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-gitlab instead\n */\nexport const createPublishGitlabMergeRequestAction =\n  gitlab.createPublishGitlabMergeRequestAction;\n","/*\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  ActionContext as ActionContextNode,\n  createTemplateAction as createTemplateActionNode,\n  TaskSecrets as TaskSecretsNode,\n  TemplateAction as TemplateActionNode,\n  executeShellCommand as executeShellCommandNode,\n  ExecuteShellCommandOptions as ExecuteShellCommandOptionsNode,\n  fetchContents as fetchContentsNode,\n} from '@backstage/plugin-scaffolder-node';\nimport { JsonObject } from '@backstage/types';\nimport { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessorModule } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';\n\n/**\n * @public\n * @deprecated Import from {@link @backstage/plugin-scaffolder-node#ActionContext} instead\n */\nexport type ActionContext<TInput extends JsonObject> =\n  ActionContextNode<TInput>;\n\n/**\n * @public\n * @deprecated Use `createTemplateAction` from `@backstage/plugin-scaffolder-node` instead\n */\nexport const createTemplateAction = createTemplateActionNode;\n\n/**\n * @public\n * @deprecated Use `TaskSecrets` from `@backstage/plugin-scaffolder-node` instead\n */\nexport type TaskSecrets = TaskSecretsNode;\n\n/**\n * @public\n * @deprecated Use `TemplateAction` from `@backstage/plugin-scaffolder-node` instead\n */\nexport type TemplateAction<TInput extends JsonObject> =\n  TemplateActionNode<TInput>;\n\n/**\n * Options for {@link executeShellCommand}.\n *\n * @public\n * @deprecated Use `ExecuteShellCommandOptions` from `@backstage/plugin-scaffolder-node` instead\n */\nexport type RunCommandOptions = ExecuteShellCommandOptionsNode;\n\n/**\n * Run a command in a sub-process, normally a shell command.\n *\n * @public\n * @deprecated Use `executeShellCommand` from `@backstage/plugin-scaffolder-node` instead\n */\nexport const executeShellCommand = executeShellCommandNode;\n\n/**\n * A helper function that reads the contents of a directory from the given URL.\n * Can be used in your own actions, and also used behind fetch:template and fetch:plain\n *\n * @public\n * @deprecated Use `fetchContents` from `@backstage/plugin-scaffolder-node` instead\n */\nexport const fetchContents = fetchContentsNode;\n\n/**\n * Adds support for scaffolder specific entity kinds to the catalog.\n *\n * @public\n * @deprecated Import from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model` instead\n */\nexport const ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessorModule;\n"],"names":["github","bitbucket","bitbucketCloud","bitbucketServer","azure","gerrit","gitlab","createTemplateActionNode","executeShellCommandNode","fetchContentsNode","ScaffolderEntitiesProcessorModule"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BO,MAAM,oCACXA,iBAAO,CAAA,kCAAA;AAKF,MAAM,8BAA8BA,iBAAO,CAAA,4BAAA;AAK3C,MAAM,gCACXA,iBAAO,CAAA,8BAAA;AAKF,MAAM,gCACXA,iBAAO,CAAA,8BAAA;AAWF,MAAM,+BAA+BA,iBAAO,CAAA,6BAAA;AAK5C,MAAM,6BAA6BA,iBAAO,CAAA,2BAAA;AAK1C,MAAM,4BAA4BA,iBAAO,CAAA,0BAAA;AAKzC,MAAM,4BAA4BA,iBAAO,CAAA,0BAAA;AAKzC,MAAM,uCACXA,iBAAO,CAAA,qCAAA;AAKF,MAAM,+BACXC,oBAAU,CAAA,6BAAA;AAKL,MAAM,oCACXC,yBAAe,CAAA,kCAAA;AAKV,MAAM,qCACXC,0BAAgB,CAAA,mCAAA;AAKX,MAAM,gDACXA,0BAAgB,CAAA,8CAAA;AAKX,MAAM,2BAA2BC,gBAAM,CAAA,yBAAA;AAKvC,MAAM,4BAA4BC,iBAAO,CAAA,0BAAA;AAKzC,MAAM,kCACXA,iBAAO,CAAA,gCAAA;AAKF,MAAM,4BAA4BC,iBAAO,CAAA,0BAAA;AAKzC,MAAM,wCACXA,iBAAO,CAAA;;ACxFF,MAAM,oBAAuB,GAAAC,0CAAA;AA6B7B,MAAM,mBAAsB,GAAAC,yCAAA;AAS5B,MAAM,aAAgB,GAAAC,mCAAA;AAQtB,MAAM,2BAA8B,GAAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/scaffolder/actions/deprecated.ts","../src/deprecated.ts"],"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 */\nimport * as github from '@backstage/plugin-scaffolder-backend-module-github';\nimport * as gitlab from '@backstage/plugin-scaffolder-backend-module-gitlab';\nimport * as azure from '@backstage/plugin-scaffolder-backend-module-azure';\nimport * as bitbucket from '@backstage/plugin-scaffolder-backend-module-bitbucket';\nimport * as bitbucketCloud from '@backstage/plugin-scaffolder-backend-module-bitbucket-cloud';\nimport * as bitbucketServer from '@backstage/plugin-scaffolder-backend-module-bitbucket-server';\nimport * as gerrit from '@backstage/plugin-scaffolder-backend-module-gerrit';\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubActionsDispatchAction =\n  github.createGithubActionsDispatchAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubDeployKeyAction = github.createGithubDeployKeyAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubEnvironmentAction =\n  github.createGithubEnvironmentAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubIssuesLabelAction =\n  github.createGithubIssuesLabelAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport type CreateGithubPullRequestActionOptions =\n  github.CreateGithubPullRequestActionOptions;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubRepoCreateAction = github.createGithubRepoCreateAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubRepoPushAction = github.createGithubRepoPushAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createGithubWebhookAction = github.createGithubWebhookAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createPublishGithubAction = github.createPublishGithubAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-github instead\n */\nexport const createPublishGithubPullRequestAction =\n  github.createPublishGithubPullRequestAction;\n\n/**\n * @public @deprecated use \"createPublishBitbucketCloudAction\" from \\@backstage/plugin-scaffolder-backend-module-bitbucket-cloud or \"createPublishBitbucketServerAction\" from \\@backstage/plugin-scaffolder-backend-module-bitbucket-server instead\n */\nexport const createPublishBitbucketAction =\n  bitbucket.createPublishBitbucketAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-bitbucket-cloud instead\n */\nexport const createPublishBitbucketCloudAction =\n  bitbucketCloud.createPublishBitbucketCloudAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-bitbucket-server instead\n */\nexport const createPublishBitbucketServerAction =\n  bitbucketServer.createPublishBitbucketServerAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-bitbucket-server instead\n */\nexport const createPublishBitbucketServerPullRequestAction =\n  bitbucketServer.createPublishBitbucketServerPullRequestAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-azure instead\n */\nexport const createPublishAzureAction = azure.createPublishAzureAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-gerrit instead\n */\nexport const createPublishGerritAction = gerrit.createPublishGerritAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-gerrit instead\n */\nexport const createPublishGerritReviewAction =\n  gerrit.createPublishGerritReviewAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-gitlab instead\n */\nexport const createPublishGitlabAction = gitlab.createPublishGitlabAction;\n\n/**\n * @public @deprecated use import from \\@backstage/plugin-scaffolder-backend-module-gitlab instead\n */\nexport const createPublishGitlabMergeRequestAction =\n  gitlab.createPublishGitlabMergeRequestAction;\n","/*\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  ActionContext as ActionContextNode,\n  createTemplateAction as createTemplateActionNode,\n  TaskSecrets as TaskSecretsNode,\n  TemplateAction as TemplateActionNode,\n  executeShellCommand as executeShellCommandNode,\n  ExecuteShellCommandOptions as ExecuteShellCommandOptionsNode,\n  fetchContents as fetchContentsNode,\n} from '@backstage/plugin-scaffolder-node';\nimport { JsonObject } from '@backstage/types';\nimport { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessorModule } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';\n\n/**\n * @public\n * @deprecated Import from {@link @backstage/plugin-scaffolder-node#ActionContext} instead\n */\nexport type ActionContext<TInput extends JsonObject> =\n  ActionContextNode<TInput>;\n\n/**\n * @public\n * @deprecated Use `createTemplateAction` from `@backstage/plugin-scaffolder-node` instead\n */\nexport const createTemplateAction = createTemplateActionNode;\n\n/**\n * @public\n * @deprecated Use `TaskSecrets` from `@backstage/plugin-scaffolder-node` instead\n */\nexport type TaskSecrets = TaskSecretsNode;\n\n/**\n * @public\n * @deprecated Use `TemplateAction` from `@backstage/plugin-scaffolder-node` instead\n */\nexport type TemplateAction<TInput extends JsonObject> =\n  TemplateActionNode<TInput>;\n\n/**\n * Options for {@link executeShellCommand}.\n *\n * @public\n * @deprecated Use `ExecuteShellCommandOptions` from `@backstage/plugin-scaffolder-node` instead\n */\nexport type RunCommandOptions = ExecuteShellCommandOptionsNode;\n\n/**\n * Run a command in a sub-process, normally a shell command.\n *\n * @public\n * @deprecated Use `executeShellCommand` from `@backstage/plugin-scaffolder-node` instead\n */\nexport const executeShellCommand = executeShellCommandNode;\n\n/**\n * A helper function that reads the contents of a directory from the given URL.\n * Can be used in your own actions, and also used behind fetch:template and fetch:plain\n *\n * @public\n * @deprecated Use `fetchContents` from `@backstage/plugin-scaffolder-node` instead\n */\nexport const fetchContents = fetchContentsNode;\n\n/**\n * Adds support for scaffolder specific entity kinds to the catalog.\n *\n * @public\n * @deprecated Import from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model` instead\n */\nexport const ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessorModule;\n"],"names":["github","bitbucket","bitbucketCloud","bitbucketServer","azure","gerrit","gitlab","createTemplateActionNode","executeShellCommandNode","fetchContentsNode","ScaffolderEntitiesProcessorModule"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BO,MAAM,oCACXA,iBAAO,CAAA,kCAAA;AAKF,MAAM,8BAA8BA,iBAAO,CAAA,4BAAA;AAK3C,MAAM,gCACXA,iBAAO,CAAA,8BAAA;AAKF,MAAM,gCACXA,iBAAO,CAAA,8BAAA;AAWF,MAAM,+BAA+BA,iBAAO,CAAA,6BAAA;AAK5C,MAAM,6BAA6BA,iBAAO,CAAA,2BAAA;AAK1C,MAAM,4BAA4BA,iBAAO,CAAA,0BAAA;AAKzC,MAAM,4BAA4BA,iBAAO,CAAA,0BAAA;AAKzC,MAAM,uCACXA,iBAAO,CAAA,qCAAA;AAKF,MAAM,+BACXC,oBAAU,CAAA,6BAAA;AAKL,MAAM,oCACXC,yBAAe,CAAA,kCAAA;AAKV,MAAM,qCACXC,0BAAgB,CAAA,mCAAA;AAKX,MAAM,gDACXA,0BAAgB,CAAA,8CAAA;AAKX,MAAM,2BAA2BC,gBAAM,CAAA,yBAAA;AAKvC,MAAM,4BAA4BC,iBAAO,CAAA,0BAAA;AAKzC,MAAM,kCACXA,iBAAO,CAAA,gCAAA;AAKF,MAAM,4BAA4BC,iBAAO,CAAA,0BAAA;AAKzC,MAAM,wCACXA,iBAAO,CAAA;;ACxFF,MAAM,oBAAuB,GAAAC,0CAAA;AA6B7B,MAAM,mBAAsB,GAAAC,yCAAA;AAS5B,MAAM,aAAgB,GAAAC,mCAAA;AAQtB,MAAM,2BAA8B,GAAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
 import { TemplateFilter as TemplateFilter$1, TemplateGlobal as TemplateGlobal$1, TemplateAction as TemplateAction$1, TaskStatus as TaskStatus$1, TaskCompletionState as TaskCompletionState$1, SerializedTask as SerializedTask$1, TaskEventType as TaskEventType$1, SerializedTaskEvent as SerializedTaskEvent$1, TaskBrokerDispatchResult as TaskBrokerDispatchResult$1, TaskBrokerDispatchOptions as TaskBrokerDispatchOptions$1, TaskContext as TaskContext$1, TaskBroker as TaskBroker$1, TaskSecrets as TaskSecrets$1, ActionContext as ActionContext$1, ExecuteShellCommandOptions, executeShellCommand as executeShellCommand$1, fetchContents as fetchContents$1 } from '@backstage/plugin-scaffolder-node';
 import * as _backstage_types from '@backstage/types';
@@ -65,14 +66,14 @@ declare function createFetchCatalogEntityAction(options: {
     catalogClient: CatalogApi;
     auth?: AuthService;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
-    entityRef?: string | undefined;
-    entityRefs?: string[] | undefined;
     optional?: boolean | undefined;
     defaultKind?: string | undefined;
     defaultNamespace?: string | undefined;
+    entityRef?: string | undefined;
+    entityRefs?: string[] | undefined;
 }, {
-    entity?: any;
     entities?: any[] | undefined;
+    entity?: any;
 }>;
 
 /**
@@ -501,6 +502,17 @@ interface TaskStore {
         events: SerializedTaskEvent[];
     }>;
     shutdownTask?(options: TaskStoreShutDownTaskOptions): Promise<void>;
+    rehydrateWorkspace?(options: {
+        taskId: string;
+        targetPath: string;
+    }): Promise<void>;
+    cleanWorkspace?({ taskId }: {
+        taskId: string;
+    }): Promise<void>;
+    serializeWorkspace?({ path, taskId, }: {
+        path: string;
+        taskId: string;
+    }): Promise<void>;
 }
 
 /**
@@ -563,6 +575,17 @@ declare class DatabaseTaskStore implements TaskStore {
         events: SerializedTaskEvent$1[];
     }>;
     shutdownTask(options: TaskStoreShutDownTaskOptions): Promise<void>;
+    rehydrateWorkspace(options: {
+        taskId: string;
+        targetPath: string;
+    }): Promise<void>;
+    cleanWorkspace({ taskId }: {
+        taskId: string;
+    }): Promise<void>;
+    serializeWorkspace(options: {
+        path: string;
+        taskId: string;
+    }): Promise<void>;
     cancelTask(options: TaskStoreEmitOptions<{
         message: string;
     } & JsonObject>): Promise<void>;
@@ -582,15 +605,20 @@ declare class TaskManager implements TaskContext$1 {
     private readonly signal;
     private readonly logger;
     private readonly auth?;
+    private readonly config?;
     private isDone;
     private heartbeatTimeoutId?;
-    static create(task: CurrentClaimedTask, storage: TaskStore, abortSignal: AbortSignal, logger: Logger, auth?: AuthService): TaskManager;
+    static create(task: CurrentClaimedTask, storage: TaskStore, abortSignal: AbortSignal, logger: Logger, auth?: AuthService, config?: Config): TaskManager;
     private constructor();
     get spec(): _backstage_plugin_scaffolder_common.TaskSpecV1beta3;
     get cancelSignal(): AbortSignal;
     get secrets(): TaskSecrets$1 | undefined;
     get createdBy(): string | undefined;
     getWorkspaceName(): Promise<string>;
+    rehydrateWorkspace?(options: {
+        taskId: string;
+        targetPath: string;
+    }): Promise<void>;
     get done(): boolean;
     emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
     getTaskState?(): Promise<{
@@ -605,8 +633,13 @@ declare class TaskManager implements TaskContext$1 {
         status: 'failed';
         reason: string;
     }): Promise<void>;
+    serializeWorkspace?(options: {
+        path: string;
+    }): Promise<void>;
+    cleanWorkspace?(): Promise<void>;
     complete(result: TaskCompletionState$1, metadata?: JsonObject): Promise<void>;
     private startTimeout;
+    private isWorkspaceSerializationEnabled;
     getInitiatorCredentials(): Promise<BackstageCredentials>;
 }
 /**
@@ -635,6 +668,7 @@ interface CurrentClaimedTask {
      * The creator of the task.
      */
     createdBy?: string;
+    workspace?: Promise<Buffer>;
 }
 
 /**

package/migrations/20240401213200_workspace.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// @ts-check
+
+/**
+ * @param {import('knex').Knex} knex
+ */
+exports.up = async function up(knex) {
+  await knex.schema.alterTable('tasks', table => {
+    table.binary('workspace').nullable().comment('A snapshot of the workspace');
+  });
+};
+
+/**
+ * @param {import('knex').Knex} knex
+ */
+exports.down = async function down(knex) {
+  await knex.schema.alterTable('tasks', table => {
+    table.dropColumn('workspace');
+  });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.22.5-next.1",
+  "version": "1.22.6-next.2",
   "description": "The Backstage backend plugin that helps you create new things",
   "backstage": {
     "role": "backend-plugin"
@@ -51,32 +51,33 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.22.0-next.1",
+    "@backstage/backend-common": "^0.22.0-next.2",
     "@backstage/backend-plugin-api": "^0.6.18-next.1",
     "@backstage/backend-tasks": "^0.5.23-next.1",
     "@backstage/catalog-client": "^1.6.5-next.0",
     "@backstage/catalog-model": "^1.5.0-next.0",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/integration": "^1.10.0",
+    "@backstage/integration": "^1.11.0-next.0",
     "@backstage/plugin-auth-node": "^0.4.13-next.1",
-    "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "^0.1.16-next.1",
-    "@backstage/plugin-catalog-node": "^1.11.2-next.1",
+    "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "^0.1.16-next.2",
+    "@backstage/plugin-catalog-node": "^1.12.0-next.2",
     "@backstage/plugin-permission-common": "^0.7.13",
     "@backstage/plugin-permission-node": "^0.7.29-next.1",
-    "@backstage/plugin-scaffolder-backend-module-azure": "^0.1.10-next.1",
-    "@backstage/plugin-scaffolder-backend-module-bitbucket": "^0.2.8-next.1",
-    "@backstage/plugin-scaffolder-backend-module-bitbucket-cloud": "^0.1.8-next.1",
-    "@backstage/plugin-scaffolder-backend-module-bitbucket-server": "^0.1.8-next.1",
-    "@backstage/plugin-scaffolder-backend-module-gerrit": "^0.1.10-next.1",
-    "@backstage/plugin-scaffolder-backend-module-gitea": "^0.1.8-next.1",
-    "@backstage/plugin-scaffolder-backend-module-github": "^0.2.8-next.1",
-    "@backstage/plugin-scaffolder-backend-module-gitlab": "^0.3.4-next.1",
+    "@backstage/plugin-scaffolder-backend-module-azure": "^0.1.10-next.2",
+    "@backstage/plugin-scaffolder-backend-module-bitbucket": "^0.2.8-next.2",
+    "@backstage/plugin-scaffolder-backend-module-bitbucket-cloud": "^0.1.8-next.2",
+    "@backstage/plugin-scaffolder-backend-module-bitbucket-server": "^0.1.8-next.2",
+    "@backstage/plugin-scaffolder-backend-module-gerrit": "^0.1.10-next.2",
+    "@backstage/plugin-scaffolder-backend-module-gitea": "^0.1.8-next.2",
+    "@backstage/plugin-scaffolder-backend-module-github": "^0.2.8-next.2",
+    "@backstage/plugin-scaffolder-backend-module-gitlab": "^0.4.0-next.2",
     "@backstage/plugin-scaffolder-common": "^1.5.2-next.1",
-    "@backstage/plugin-scaffolder-node": "^0.4.4-next.1",
+    "@backstage/plugin-scaffolder-node": "^0.4.4-next.2",
     "@backstage/types": "^1.1.1",
     "@types/express": "^4.17.6",
     "@types/luxon": "^3.0.0",
+    "concat-stream": "^2.0.0",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
     "fs-extra": "^11.2.0",
@@ -92,6 +93,7 @@
     "p-limit": "^3.1.0",
     "p-queue": "^6.6.2",
     "prom-client": "^15.0.0",
+    "tar": "^6.1.12",
     "uuid": "^9.0.0",
     "winston": "^3.2.1",
     "winston-transport": "^4.7.0",
@@ -100,8 +102,8 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.3.8-next.1",
-    "@backstage/cli": "^0.26.5-next.0",
+    "@backstage/backend-test-utils": "^0.3.8-next.2",
+    "@backstage/cli": "^0.26.5-next.1",
     "@backstage/plugin-scaffolder-node-test-utils": "^0.1.4-next.1",
     "@types/fs-extra": "^11.0.0",
     "@types/nunjucks": "^3.1.4",