@backstage/plugin-scaffolder-backend 1.2.0 → 1.3.0-next.2

package/dist/index.d.ts

@@ -125,6 +125,7 @@ interface TaskContext {
     secrets?: TaskSecrets;
     createdBy?: string;
     done: boolean;
+    isDryRun?: boolean;
     emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
     complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
     getWorkspaceName(): Promise<string>;
@@ -147,6 +148,11 @@ interface TaskBroker {
         events: SerializedTaskEvent[];
     }>;
     get(taskId: string): Promise<SerializedTask>;
+    list?(options?: {
+        createdBy?: string;
+    }): Promise<{
+        tasks: SerializedTask[];
+    }>;
 }
 /**
  * TaskStoreEmitOptions
@@ -204,6 +210,11 @@ interface TaskStore {
             taskId: string;
         }[];
     }>;
+    list?(options: {
+        createdBy?: string;
+    }): Promise<{
+        tasks: SerializedTask[];
+    }>;
     emitLogEvent({ taskId, body }: TaskStoreEmitOptions): Promise<void>;
     listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
         events: SerializedTaskEvent[];
@@ -226,11 +237,17 @@ declare type ActionContext<Input extends JsonObject> = {
      */
     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;
 };
 /** @public */
 declare type TemplateAction<Input extends JsonObject> = {
     id: string;
     description?: string;
+    supportsDryRun?: boolean;
     schema?: {
         input?: Schema;
         output?: Schema;
@@ -447,6 +464,23 @@ declare function createPublishFileAction(): TemplateAction<{
     path: string;
 }>;
 
+/**
+ * Creates a new action that initializes a git repository of the content in the workspace
+ * and publishes it to a Gerrit instance.
+ * @public
+ */
+declare function createPublishGerritAction(options: {
+    integrations: ScmIntegrationRegistry;
+    config: Config;
+}): TemplateAction<{
+    repoUrl: string;
+    description: string;
+    defaultBranch?: string | undefined;
+    gitCommitMessage?: string | undefined;
+    gitAuthorName?: string | undefined;
+    gitAuthorEmail?: string | undefined;
+}>;
+
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
  * and publishes it to GitHub.
@@ -462,6 +496,7 @@ declare function createPublishGithubAction(options: {
     description?: string | undefined;
     access?: string | undefined;
     defaultBranch?: string | undefined;
+    protectDefaultBranch?: boolean | undefined;
     deleteBranchOnMerge?: boolean | undefined;
     gitCommitMessage?: string | undefined;
     gitAuthorName?: string | undefined;
@@ -473,10 +508,17 @@ declare function createPublishGithubAction(options: {
     requireCodeOwnerReviews?: boolean | undefined;
     requiredStatusCheckContexts?: string[] | undefined;
     repoVisibility?: "internal" | "private" | "public" | undefined;
-    collaborators?: {
+    collaborators?: ({
+        user: string;
+        access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
+    } | {
+        team: string;
+        access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
+    } | {
+        /** @deprecated This field is deprecated in favor of team */
         username: string;
         access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
-    }[] | undefined;
+    })[] | undefined;
     token?: string | undefined;
     topics?: string[] | undefined;
 }>;
@@ -674,6 +716,11 @@ declare class DatabaseTaskStore implements TaskStore {
     private readonly db;
     static create(options: DatabaseTaskStoreOptions): Promise<DatabaseTaskStore>;
     private constructor();
+    list(options: {
+        createdBy?: string;
+    }): Promise<{
+        tasks: SerializedTask[];
+    }>;
     getTask(taskId: string): Promise<SerializedTask>;
     createTask(options: TaskStoreCreateTaskOptions): Promise<TaskStoreCreateTaskResult>;
     claimTask(): Promise<SerializedTask | undefined>;
@@ -800,4 +847,4 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
-export { ActionContext, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubIssuesLabelAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishBitbucketCloudAction, createPublishBitbucketServerAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, executeShellCommand, fetchContents };
+export { ActionContext, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubIssuesLabelAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishBitbucketCloudAction, createPublishBitbucketServerAction, createPublishFileAction, createPublishGerritAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, executeShellCommand, fetchContents };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
   "description": "The Backstage backend plugin that helps you create new things",
-  "version": "1.2.0",
+  "version": "1.3.0-next.2",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -34,14 +34,14 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.13.3",
-    "@backstage/catalog-client": "^1.0.2",
-    "@backstage/catalog-model": "^1.0.2",
+    "@backstage/backend-common": "^0.14.0-next.2",
+    "@backstage/catalog-client": "^1.0.3-next.0",
+    "@backstage/catalog-model": "^1.0.3-next.0",
     "@backstage/config": "^1.0.1",
     "@backstage/errors": "^1.0.0",
-    "@backstage/integration": "^1.2.0",
-    "@backstage/plugin-catalog-backend": "^1.1.2",
-    "@backstage/plugin-scaffolder-common": "^1.1.0",
+    "@backstage/integration": "^1.2.1-next.2",
+    "@backstage/plugin-catalog-backend": "^1.2.0-next.2",
+    "@backstage/plugin-scaffolder-common": "^1.1.1-next.0",
     "@backstage/types": "^1.0.0",
     "@gitbeaker/core": "^35.6.0",
     "@gitbeaker/node": "^35.1.0",
@@ -67,15 +67,17 @@
     "nunjucks": "^3.2.3",
     "octokit": "^1.7.1",
     "octokit-plugin-create-pull-request": "^3.10.0",
+    "p-limit": "^3.1.0",
     "uuid": "^8.2.0",
     "vm2": "^3.9.6",
     "winston": "^3.2.1",
     "yaml": "^1.10.0",
-    "zen-observable": "^0.8.15"
+    "zen-observable": "^0.8.15",
+    "zod": "^3.11.6"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.24",
-    "@backstage/cli": "^0.17.1",
+    "@backstage/backend-test-utils": "^0.1.25-next.2",
+    "@backstage/cli": "^0.17.2-next.2",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -86,7 +88,7 @@
     "esbuild": "^0.14.1",
     "jest-when": "^3.1.0",
     "mock-fs": "^5.1.0",
-    "msw": "^0.35.0",
+    "msw": "^0.42.0",
     "supertest": "^6.1.3",
     "yaml": "^1.10.0"
   },
@@ -97,5 +99,5 @@
     "assets"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "96323f280ba32ee526c5b151cda42260aee927c9"
+  "gitHead": "afc672d59763a835574e6c47819107d22cfd1ad7"
 }