@backstage/plugin-scaffolder-backend 1.10.0 → 1.11.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.11.0-next.0
+
+### Minor Changes
+
+- 0b2952ee4b: Added the option to overwrite files in the `targetPath` of the `template:fetch` action
+
+### Patch Changes
+
+- ad3edc402d: **Deprecations**: The following are deprecated and should instead be imported from the new package `@backstage/plugin-scaffolder-node`:
+
+  - `ActionContext`
+  - `createTemplateAction`
+  - `TaskSecrets`
+  - `TemplateAction`
+
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.1.0-next.0
+  - @backstage/catalog-model@1.1.6-next.0
+  - @backstage/backend-common@0.18.2-next.0
+  - @backstage/catalog-client@1.3.1-next.0
+  - @backstage/plugin-catalog-backend@1.7.2-next.0
+  - @backstage/plugin-catalog-node@1.3.3-next.0
+  - @backstage/plugin-scaffolder-common@1.2.5-next.0
+  - @backstage/backend-tasks@0.4.3-next.0
+  - @backstage/plugin-auth-node@0.2.11-next.0
+  - @backstage/backend-plugin-api@0.3.2-next.0
+
 ## 1.10.0
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.10.0",
+  "version": "1.11.0-next.0",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -6,6 +6,7 @@
 
 /// <reference types="node" />
 
+import { ActionContext as ActionContext_2 } from '@backstage/plugin-scaffolder-node';
 import { BackendFeature } from '@backstage/backend-plugin-api';
 import { CatalogApi } from '@backstage/catalog-client';
 import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
@@ -25,52 +26,21 @@ import { Observable } from '@backstage/types';
 import { Octokit } from 'octokit';
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { PluginTaskScheduler } from '@backstage/backend-tasks';
-import { Schema } from 'jsonschema';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { ScmIntegrations } from '@backstage/integration';
 import { SpawnOptionsWithoutStdio } from 'child_process';
+import { TaskSecrets as TaskSecrets_2 } from '@backstage/plugin-scaffolder-node';
 import { TaskSpec } from '@backstage/plugin-scaffolder-common';
 import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common';
-import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
+import { TemplateAction as TemplateAction_2 } from '@backstage/plugin-scaffolder-node';
 import { UrlReader } from '@backstage/backend-common';
-import { UserEntity } from '@backstage/catalog-model';
 import { Writable } from 'stream';
 
 /**
- * ActionContext is passed into scaffolder actions.
  * @public
+ * @deprecated Import from {@link @backstage/plugin-scaffolder-node#ActionContext} instead
  */
-export declare type ActionContext<Input extends JsonObject> = {
-    logger: Logger;
-    logStream: Writable;
-    secrets?: TaskSecrets;
-    workspacePath: string;
-    input: Input;
-    output(name: string, value: JsonValue): void;
-    /**
-     * Creates a temporary directory for use by the action, which is then cleaned up automatically.
-     */
-    createTemporaryDirectory(): Promise<string>;
-    templateInfo?: TemplateInfo;
-    /**
-     * Whether this action invocation is a dry-run or not.
-     * This will only ever be true if the actions as marked as supporting dry-runs.
-     */
-    isDryRun?: boolean;
-    /**
-     * The user which triggered the action.
-     */
-    user?: {
-        /**
-         * The decorated entity from the Catalog
-         */
-        entity?: UserEntity;
-        /**
-         * An entity ref for the author of the task
-         */
-        ref?: string;
-    };
-};
+export declare type ActionContext<TInput extends JsonObject> = ActionContext_2<TInput>;
 
 /**
  * A function to generate create a list of default actions that the scaffolder provides.
@@ -79,7 +49,7 @@ export declare type ActionContext<Input extends JsonObject> = {
  * @public
  * @returns A list of actions that can be used in the scaffolder
  */
-export declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => TemplateAction<JsonObject>[];
+export declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => TemplateAction_2<JsonObject>[];
 
 /**
  * The options passed to {@link createBuiltinActions}
@@ -117,7 +87,7 @@ export declare interface CreateBuiltInActionsOptions {
 export declare function createCatalogRegisterAction(options: {
     catalogClient: CatalogApi;
     integrations: ScmIntegrations;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 catalogInfoUrl: string;
 optional?: boolean | undefined;
 } | {
@@ -130,7 +100,7 @@ optional?: boolean | undefined;
  * Writes a catalog descriptor file containing the provided entity to a path in the workspace.
  * @public
  */
-export declare function createCatalogWriteAction(): TemplateAction<    {
+export declare function createCatalogWriteAction(): TemplateAction_2<    {
 filePath?: string | undefined;
 entity: Entity;
 }>;
@@ -145,7 +115,7 @@ entity: Entity;
  *
  * @public
  */
-export declare function createDebugLogAction(): TemplateAction<    {
+export declare function createDebugLogAction(): TemplateAction_2<    {
 message?: string | undefined;
 listWorkspace?: boolean | undefined;
 }>;
@@ -156,7 +126,7 @@ listWorkspace?: boolean | undefined;
  */
 export declare function createFetchCatalogEntityAction(options: {
     catalogClient: CatalogApi;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 entityRef: string;
 optional?: boolean | undefined;
 }>;
@@ -169,7 +139,7 @@ optional?: boolean | undefined;
 export declare function createFetchPlainAction(options: {
     reader: UrlReader;
     integrations: ScmIntegrations;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 url: string;
 targetPath?: string | undefined;
 }>;
@@ -186,7 +156,7 @@ export declare function createFetchTemplateAction(options: {
     integrations: ScmIntegrations;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
     additionalTemplateGlobals?: Record<string, TemplateGlobal>;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 url: string;
 targetPath?: string | undefined;
 values: any;
@@ -197,13 +167,14 @@ templateFileExtension?: string | boolean | undefined;
 copyWithoutRender?: string[] | undefined;
 copyWithoutTemplating?: string[] | undefined;
 cookiecutterCompat?: boolean | undefined;
+replace?: boolean | undefined;
 }>;
 
 /**
  * Creates new action that enables deletion of files and directories in the workspace.
  * @public
  */
-export declare const createFilesystemDeleteAction: () => TemplateAction<    {
+export declare const createFilesystemDeleteAction: () => TemplateAction_2<    {
 files: string[];
 }>;
 
@@ -211,7 +182,7 @@ files: string[];
  * Creates a new action that allows renames of files and directories in the workspace.
  * @public
  */
-export declare const createFilesystemRenameAction: () => TemplateAction<    {
+export declare const createFilesystemRenameAction: () => TemplateAction_2<    {
 files: Array<{
 from: string;
 to: string;
@@ -226,7 +197,7 @@ overwrite?: boolean;
 export declare function createGithubActionsDispatchAction(options: {
     integrations: ScmIntegrations;
     githubCredentialsProvider?: GithubCredentialsProvider;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 workflowId: string;
 branchOrTagName: string;
@@ -243,7 +214,7 @@ token?: string | undefined;
 export declare function createGithubIssuesLabelAction(options: {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 number: number;
 labels: string[];
@@ -290,7 +261,7 @@ export declare type CreateGithubPullRequestClientFactoryInput = {
 export declare function createGithubRepoCreateAction(options: {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 description?: string | undefined;
 homepage?: string | undefined;
@@ -349,7 +320,7 @@ export declare function createGithubRepoPushAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
     githubCredentialsProvider?: GithubCredentialsProvider;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
@@ -387,7 +358,7 @@ export declare function createGithubWebhookAction(options: {
     integrations: ScmIntegrationRegistry;
     defaultWebhookSecret?: string;
     githubCredentialsProvider?: GithubCredentialsProvider;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 webhookUrl: string;
 webhookSecret?: string | undefined;
@@ -406,7 +377,7 @@ token?: string | undefined;
 export declare function createPublishAzureAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
@@ -426,7 +397,7 @@ gitAuthorEmail?: string | undefined;
 export declare function createPublishBitbucketAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
@@ -447,7 +418,7 @@ gitAuthorEmail?: string | undefined;
 export declare function createPublishBitbucketCloudAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
@@ -464,7 +435,7 @@ token?: string | undefined;
 export declare function createPublishBitbucketServerAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
@@ -485,7 +456,7 @@ gitAuthorEmail?: string | undefined;
 export declare function createPublishGerritAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 description: string;
 defaultBranch?: string | undefined;
@@ -502,7 +473,7 @@ sourcePath?: string | undefined;
 export declare function createPublishGerritReviewAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 branch?: string | undefined;
 sourcePath?: string | undefined;
@@ -521,7 +492,7 @@ export declare function createPublishGithubAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
     githubCredentialsProvider?: GithubCredentialsProvider;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 description?: string | undefined;
 homepage?: string | undefined;
@@ -580,7 +551,7 @@ requiredCommitSigning?: boolean | undefined;
  * Creates a Github Pull Request action.
  * @public
  */
-export declare const createPublishGithubPullRequestAction: ({ integrations, githubCredentialsProvider, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction<    {
+export declare const createPublishGithubPullRequestAction: ({ integrations, githubCredentialsProvider, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction_2<    {
 title: string;
 branchName: string;
 description: string;
@@ -602,7 +573,7 @@ teamReviewers?: string[] | undefined;
 export declare function createPublishGitlabAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
-}): TemplateAction<    {
+}): TemplateAction_2<    {
 repoUrl: string;
 defaultBranch?: string | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
@@ -622,7 +593,7 @@ topics?: string[] | undefined;
  */
 export declare const createPublishGitlabMergeRequestAction: (options: {
     integrations: ScmIntegrationRegistry;
-}) => TemplateAction<    {
+}) => TemplateAction_2<    {
 repoUrl: string;
 title: string;
 description: string;
@@ -644,10 +615,10 @@ assignee?: string | undefined;
 export declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
 /**
- * This function is used to create new template actions to get type safety.
  * @public
+ * @deprecated Use `createTemplateAction` from `@backstage/plugin-scaffolder-node` instead
  */
-export declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
+export declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction_2<TInput>) => TemplateAction_2<TInput>;
 
 /**
  * CreateWorkerOptions
@@ -694,7 +665,7 @@ export declare interface CurrentClaimedTask {
     /**
      * The secrets that are stored with the task.
      */
-    secrets?: TaskSecrets;
+    secrets?: TaskSecrets_2;
     /**
      * The creator of the task.
      */
@@ -794,7 +765,7 @@ export declare interface RouterOptions {
     database: PluginDatabaseManager;
     catalogClient: CatalogApi;
     scheduler?: PluginTaskScheduler;
-    actions?: TemplateAction<any>[];
+    actions?: TemplateAction_2<any>[];
     /**
      * @deprecated taskWorkers is deprecated in favor of concurrentTasksLimit option with a single TaskWorker
      * @defaultValue 1
@@ -839,16 +810,18 @@ export declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
 
 /**
  * Catalog plugin
+ *
  * @alpha
  */
 export declare const scaffolderPlugin: (options: ScaffolderPluginOptions) => BackendFeature;
 
 /**
  * Catalog plugin options
+ *
  * @alpha
  */
 export declare type ScaffolderPluginOptions = {
-    actions?: TemplateAction<any>[];
+    actions?: TemplateAction_2<any>[];
     taskWorkers?: number;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
@@ -867,7 +840,7 @@ export declare type SerializedTask = {
     createdAt: string;
     lastHeartbeatAt?: string;
     createdBy?: string;
-    secrets?: TaskSecrets;
+    secrets?: TaskSecrets_2;
 };
 
 /**
@@ -916,7 +889,7 @@ export declare interface TaskBroker {
  */
 export declare type TaskBrokerDispatchOptions = {
     spec: TaskSpec;
-    secrets?: TaskSecrets;
+    secrets?: TaskSecrets_2;
     createdBy?: string;
 };
 
@@ -943,7 +916,7 @@ export declare type TaskCompletionState = 'failed' | 'completed';
  */
 export declare interface TaskContext {
     spec: TaskSpec;
-    secrets?: TaskSecrets;
+    secrets?: TaskSecrets_2;
     createdBy?: string;
     done: boolean;
     isDryRun?: boolean;
@@ -973,7 +946,7 @@ export declare class TaskManager implements TaskContext {
     static create(task: CurrentClaimedTask, storage: TaskStore, logger: Logger): TaskManager;
     private constructor();
     get spec(): TaskSpecV1beta3;
-    get secrets(): TaskSecrets | undefined;
+    get secrets(): TaskSecrets_2 | undefined;
     get createdBy(): string | undefined;
     getWorkspaceName(): Promise<string>;
     get done(): boolean;
@@ -983,13 +956,10 @@ export declare class TaskManager implements TaskContext {
 }
 
 /**
- * TaskSecrets
- *
  * @public
+ * @deprecated Use `TaskSecrets` from `@backstage/plugin-scaffolder-node` instead
  */
-export declare type TaskSecrets = Record<string, string> & {
-    backstageToken?: string;
-};
+export declare type TaskSecrets = TaskSecrets_2;
 
 /**
  * The status of each step of the Task
@@ -1039,7 +1009,7 @@ export declare interface TaskStore {
 export declare type TaskStoreCreateTaskOptions = {
     spec: TaskSpec;
     createdBy?: string;
-    secrets?: TaskSecrets;
+    secrets?: TaskSecrets_2;
 };
 
 /**
@@ -1094,21 +1064,11 @@ export declare class TaskWorker {
     runOneTask(task: TaskContext): Promise<void>;
 }
 
-/** @public */
-export declare type TemplateAction<Input extends JsonObject> = {
-    id: string;
-    description?: string;
-    examples?: {
-        description: string;
-        example: string;
-    }[];
-    supportsDryRun?: boolean;
-    schema?: {
-        input?: Schema;
-        output?: Schema;
-    };
-    handler: (ctx: ActionContext<Input>) => Promise<void>;
-};
+/**
+ * @public
+ * @deprecated Use `TemplateAction` from `@backstage/plugin-scaffolder-node` instead
+ */
+export declare type TemplateAction<TInput extends JsonObject> = TemplateAction_2<TInput>;
 
 /**
  * Registry of all registered template actions.
@@ -1116,9 +1076,9 @@ export declare type TemplateAction<Input extends JsonObject> = {
  */
 export declare class TemplateActionRegistry {
     private readonly actions;
-    register<TInput extends JsonObject>(action: TemplateAction<TInput>): void;
-    get(actionId: string): TemplateAction<JsonObject>;
-    list(): TemplateAction<JsonObject>[];
+    register<TInput extends JsonObject>(action: TemplateAction_2<TInput>): void;
+    get(actionId: string): TemplateAction_2<JsonObject>;
+    list(): TemplateAction_2<JsonObject>[];
 }
 
 /** @public */