@backstage/plugin-scaffolder-backend 1.1.0 → 1.2.0

package/dist/index.d.ts

@@ -67,6 +67,7 @@ declare type SerializedTask = {
     status: TaskStatus;
     createdAt: string;
     lastHeartbeatAt?: string;
+    createdBy?: string;
     secrets?: TaskSecrets;
 };
 /**
@@ -112,6 +113,7 @@ declare type TaskBrokerDispatchResult = {
 declare type TaskBrokerDispatchOptions = {
     spec: TaskSpec;
     secrets?: TaskSecrets;
+    createdBy?: string;
 };
 /**
  * Task
@@ -121,6 +123,7 @@ declare type TaskBrokerDispatchOptions = {
 interface TaskContext {
     spec: TaskSpec;
     secrets?: TaskSecrets;
+    createdBy?: string;
     done: boolean;
     emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
     complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
@@ -169,6 +172,7 @@ declare type TaskStoreListEventsOptions = {
  */
 declare type TaskStoreCreateTaskOptions = {
     spec: TaskSpec;
+    createdBy?: string;
     secrets?: TaskSecrets;
 };
 /**
@@ -366,16 +370,58 @@ declare function createPublishAzureAction(options: {
     defaultBranch?: string | undefined;
     sourcePath?: string | undefined;
     token?: 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 Bitbucket.
  * @public
+ * @deprecated in favor of createPublishBitbucketCloudAction and createPublishBitbucketServerAction
  */
 declare function createPublishBitbucketAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
+}): TemplateAction<{
+    repoUrl: string;
+    description?: string | undefined;
+    defaultBranch?: string | undefined;
+    repoVisibility?: "private" | "public" | undefined;
+    sourcePath?: string | undefined;
+    enableLFS?: boolean | undefined;
+    token?: 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 Bitbucket Cloud.
+ * @public
+ */
+declare function createPublishBitbucketCloudAction(options: {
+    integrations: ScmIntegrationRegistry;
+    config: Config;
+}): TemplateAction<{
+    repoUrl: string;
+    description?: string | undefined;
+    defaultBranch?: string | undefined;
+    repoVisibility?: "private" | "public" | undefined;
+    sourcePath?: string | undefined;
+    token?: string | undefined;
+}>;
+
+/**
+ * Creates a new action that initializes a git repository of the content in the workspace
+ * and publishes it to Bitbucket Server.
+ * @public
+ */
+declare function createPublishBitbucketServerAction(options: {
+    integrations: ScmIntegrationRegistry;
+    config: Config;
 }): TemplateAction<{
     repoUrl: string;
     description?: string | undefined;
@@ -417,11 +463,15 @@ declare function createPublishGithubAction(options: {
     access?: string | undefined;
     defaultBranch?: string | undefined;
     deleteBranchOnMerge?: boolean | undefined;
+    gitCommitMessage?: string | undefined;
+    gitAuthorName?: string | undefined;
+    gitAuthorEmail?: string | undefined;
     allowRebaseMerge?: boolean | undefined;
     allowSquashMerge?: boolean | undefined;
     allowMergeCommit?: boolean | undefined;
     sourcePath?: string | undefined;
     requireCodeOwnerReviews?: boolean | undefined;
+    requiredStatusCheckContexts?: string[] | undefined;
     repoVisibility?: "internal" | "private" | "public" | undefined;
     collaborators?: {
         username: string;
@@ -663,6 +713,7 @@ declare class TaskManager implements TaskContext {
     private constructor();
     get spec(): _backstage_plugin_scaffolder_common.TaskSpecV1beta3;
     get secrets(): TaskSecrets | undefined;
+    get createdBy(): string | undefined;
     getWorkspaceName(): Promise<string>;
     get done(): boolean;
     emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
@@ -687,6 +738,10 @@ interface CurrentClaimedTask {
      * The secrets that are stored with the task.
      */
     secrets?: TaskSecrets;
+    /**
+     * The creator of the task.
+     */
+    createdBy?: string;
 }
 
 /**
@@ -745,4 +800,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, 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, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, executeShellCommand, fetchContents };

package/migrations/20220129100000_created_by.js

@@ -0,0 +1,38 @@
+/*
+ * 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
+      .text('created_by')
+      .nullable()
+      .comment('An entityRef of the user who created the task');
+  });
+};
+
+/**
+ * @param {import('knex').Knex} knex
+ */
+exports.down = async function down(knex) {
+  await knex.schema.alterTable('tasks', table => {
+    table.dropColumn('created_by');
+  });
+};

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.1.0",
+  "version": "1.2.0",
   "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.2",
-    "@backstage/catalog-client": "^1.0.1",
-    "@backstage/catalog-model": "^1.0.1",
-    "@backstage/config": "^1.0.0",
+    "@backstage/backend-common": "^0.13.3",
+    "@backstage/catalog-client": "^1.0.2",
+    "@backstage/catalog-model": "^1.0.2",
+    "@backstage/config": "^1.0.1",
     "@backstage/errors": "^1.0.0",
-    "@backstage/integration": "^1.1.0",
-    "@backstage/plugin-catalog-backend": "^1.1.0",
-    "@backstage/plugin-scaffolder-common": "^1.0.1",
+    "@backstage/integration": "^1.2.0",
+    "@backstage/plugin-catalog-backend": "^1.1.2",
+    "@backstage/plugin-scaffolder-common": "^1.1.0",
     "@backstage/types": "^1.0.0",
     "@gitbeaker/core": "^35.6.0",
     "@gitbeaker/node": "^35.1.0",
@@ -53,7 +53,7 @@
     "cors": "^2.8.5",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
-    "fs-extra": "10.0.1",
+    "fs-extra": "10.1.0",
     "git-url-parse": "^11.6.0",
     "globby": "^11.0.0",
     "isbinaryfile": "^5.0.0",
@@ -74,8 +74,8 @@
     "zen-observable": "^0.8.15"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.23",
-    "@backstage/cli": "^0.17.0",
+    "@backstage/backend-test-utils": "^0.1.24",
+    "@backstage/cli": "^0.17.1",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -97,5 +97,5 @@
     "assets"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "e0e44c433319711c2fb8b175db411a621f7aaec2"
+  "gitHead": "96323f280ba32ee526c5b151cda42260aee927c9"
 }