@backstage/plugin-scaffolder-backend 0.17.3 → 1.0.0

package/dist/index.d.ts

@@ -5,13 +5,12 @@ import { Logger } from 'winston';
 import { Writable } from 'stream';
 import { JsonValue, JsonObject, Observable } from '@backstage/types';
 import { Schema } from 'jsonschema';
-import { TaskSpec, TemplateMetadata, TemplateInfo } from '@backstage/plugin-scaffolder-common';
+import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
+import { TaskSpec, TemplateInfo } from '@backstage/plugin-scaffolder-common';
 import { Entity } from '@backstage/catalog-model';
-import { UrlReader, ContainerRunner, PluginDatabaseManager } from '@backstage/backend-common';
+import { UrlReader, PluginDatabaseManager } from '@backstage/backend-common';
 import { Config } from '@backstage/config';
 import { createPullRequest } from 'octokit-plugin-create-pull-request';
-import { Octokit } from 'octokit';
-export { createFetchCookiecutterAction } from '@backstage/plugin-scaffolder-backend-module-cookiecutter';
 import { SpawnOptionsWithoutStdio } from 'child_process';
 import { Knex } from 'knex';
 import express from 'express';
@@ -51,26 +50,12 @@ declare type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
  * @public
  */
 declare type TaskStatus = 'open' | 'processing' | 'failed' | 'cancelled' | 'completed';
-/**
- * The status of each step of the Task
- *
- * @public
- * @deprecated use TaskStatus instead
- */
-declare type Status = TaskStatus;
 /**
  * The state of a completed task.
  *
  * @public
  */
 declare type TaskCompletionState = 'failed' | 'completed';
-/**
- * The state of a completed task.
- *
- * @public
- * @deprecated use TaskCompletionState instead
- */
-declare type CompletedTaskState = TaskCompletionState;
 /**
  * SerializedTask
  *
@@ -128,13 +113,6 @@ declare type TaskBrokerDispatchOptions = {
     spec: TaskSpec;
     secrets?: TaskSecrets;
 };
-/**
- * DispatchResult
- *
- * @public
- * @deprecated use TaskBrokerDispatchResult instead
- */
-declare type DispatchResult = TaskBrokerDispatchResult;
 /**
  * Task
  *
@@ -230,13 +208,9 @@ interface TaskStore {
 
 /**
  * ActionContext is passed into scaffolder actions.
- * @public */
+ * @public
+ */
 declare type ActionContext<Input extends JsonObject> = {
-    /**
-     * Base URL for the location of the task spec, typically the url of the source entity file.
-     * @deprecated please use templateInfo.baseUrl instead
-     */
-    baseUrl?: string;
     logger: Logger;
     logStream: Writable;
     secrets?: TaskSecrets;
@@ -247,10 +221,6 @@ declare type ActionContext<Input extends JsonObject> = {
      * Creates a temporary directory for use by the action, which is then cleaned up automatically.
      */
     createTemporaryDirectory(): Promise<string>;
-    /**
-     * @deprecated please use templateInfo instead
-     */
-    metadata?: TemplateMetadata;
     templateInfo?: TemplateInfo;
 };
 /** @public */
@@ -269,12 +239,26 @@ declare type TemplateAction<Input extends JsonObject> = {
  * @public
  */
 interface CreateBuiltInActionsOptions {
+    /**
+     * The {@link @backstage/backend-common#UrlReader} interface that will be used in the default actions.
+     */
     reader: UrlReader;
+    /**
+     * The {@link @backstage/integrations#ScmIntegrations} that will be used in the default actions.
+     */
     integrations: ScmIntegrations;
+    /**
+     * The {@link @backstage/catalog-client#CatalogApi} that will be used in the default actions.
+     */
     catalogClient: CatalogApi;
-    /** @deprecated when the cookiecutter action is removed this won't be necessary */
-    containerRunner?: ContainerRunner;
+    /**
+     * The {@link @backstage/config#Config} that will be used in the default actions.
+     */
     config: Config;
+    /**
+     * Additional custom filters that will be passed to the nunjucks template engine for use in
+     * Template Manifests and also template skeleton files when using `fetch:template`.
+     */
     additionalTemplateFilters?: Record<string, TemplateFilter>;
 }
 /**
@@ -432,6 +416,10 @@ declare function createPublishGithubAction(options: {
     description?: string | undefined;
     access?: string | undefined;
     defaultBranch?: string | undefined;
+    deleteBranchOnMerge?: boolean | undefined;
+    allowRebaseMerge?: boolean | undefined;
+    allowSquashMerge?: boolean | undefined;
+    allowMergeCommit?: boolean | undefined;
     sourcePath?: string | undefined;
     requireCodeOwnerReviews?: boolean | undefined;
     repoVisibility?: "internal" | "private" | "public" | undefined;
@@ -448,10 +436,14 @@ interface OctokitWithPullRequestPluginClient {
     createPullRequest(options: createPullRequest.Options): Promise<{
         data: {
             html_url: string;
+            number: number;
         };
     } | null>;
 }
-/** @public */
+/**
+ * The options passed to the client factory function.
+ * @public
+ */
 declare type CreateGithubPullRequestClientFactoryInput = {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
@@ -460,10 +452,22 @@ declare type CreateGithubPullRequestClientFactoryInput = {
     repo: string;
     token?: string;
 };
-/** @public */
+/**
+ * The options passed to {@link createPublishGithubPullRequestAction} method
+ * @public
+ */
 interface CreateGithubPullRequestActionOptions {
+    /**
+     * An instance of {@link @backstage/integration#ScmIntegrationRegistry} that will be used in the action.
+     */
     integrations: ScmIntegrationRegistry;
+    /**
+     * An instance of {@link @backstage/integration#GithubCredentialsProvider} that will be used to get credentials for the action.
+     */
     githubCredentialsProvider?: GithubCredentialsProvider;
+    /**
+     * A method to return the Octokit client with the Pull Request Plugin.
+     */
     clientFactory?: (input: CreateGithubPullRequestClientFactoryInput) => Promise<OctokitWithPullRequestPluginClient>;
 }
 /**
@@ -550,35 +554,19 @@ declare function createGithubWebhookAction(options: {
     token?: string | undefined;
 }>;
 
-declare type OctokitIntegration = {
-    client: Octokit;
-    token: string;
-    owner: string;
-    repo: string;
-};
 /**
- * OctokitProvider provides Octokit client based on ScmIntegrationsRegistry configuration.
- * OctokitProvider supports GitHub credentials caching out of the box.
- *
- * @deprecated we are no longer providing a way from the scaffolder to generate octokit instances.
- * Implement your own if you're using this method from an external package, or use the internal `getOctokitOptions` function instead
+ * Adds labels to a pull request or issue on GitHub
+ * @public
  */
-declare class OctokitProvider {
-    private readonly integrations;
-    private readonly githubCredentialsProvider;
-    constructor(integrations: ScmIntegrationRegistry, githubCredentialsProvider?: GithubCredentialsProvider);
-    /**
-     * gets standard Octokit client based on repository URL.
-     *
-     * @param repoUrl - Repository URL
-     *
-     * @deprecated we are no longer providing a way from the scaffolder to generate octokit instances.
-     * Implement your own if you're using this method from an external package, or use the internal `getOctokitOptions` function instead
-     */
-    getOctokit(repoUrl: string, options?: {
-        token?: string;
-    }): Promise<OctokitIntegration>;
-}
+declare function createGithubIssuesLabelAction(options: {
+    integrations: ScmIntegrationRegistry;
+    githubCredentialsProvider?: GithubCredentialsProvider;
+}): TemplateAction<{
+    repoUrl: string;
+    number: number;
+    labels: string[];
+    token?: string | undefined;
+}>;
 
 /** @public */
 declare type RunCommandOptions = {
@@ -597,12 +585,6 @@ declare type RunCommandOptions = {
  * @public
  */
 declare const executeShellCommand: (options: RunCommandOptions) => Promise<void>;
-/**
- * Run a command in a sub-process, normally a shell command.
- * @public
- * @deprecated use {@link executeShellCommand} instead
- */
-declare const runCommand: (options: RunCommandOptions) => Promise<void>;
 
 /**
  * Registry of all registered template actions.
@@ -675,7 +657,7 @@ declare class TaskManager implements TaskContext {
     private heartbeatTimeoutId?;
     static create(task: CurrentClaimedTask, storage: TaskStore, logger: Logger): TaskManager;
     private constructor();
-    get spec(): TaskSpec;
+    get spec(): _backstage_plugin_scaffolder_common.TaskSpecV1beta3;
     get secrets(): TaskSecrets | undefined;
     getWorkspaceName(): Promise<string>;
     get done(): boolean;
@@ -689,17 +671,19 @@ declare class TaskManager implements TaskContext {
  * @public
  */
 interface CurrentClaimedTask {
+    /**
+     * The TaskSpec of the current claimed task.
+     */
     spec: TaskSpec;
+    /**
+     * The uuid of the current claimed task.
+     */
     taskId: string;
+    /**
+     * The secrets that are stored with the task.
+     */
     secrets?: TaskSecrets;
 }
-/**
- * TaskState
- *
- * @public
- * @deprecated use CurrentClaimedTask instead
- */
-declare type TaskState = CurrentClaimedTask;
 
 /**
  * CreateWorkerOptions
@@ -740,11 +724,13 @@ interface RouterOptions {
     catalogClient: CatalogApi;
     actions?: TemplateAction<any>[];
     taskWorkers?: number;
-    containerRunner?: ContainerRunner;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
 }
-/** @public */
+/**
+ * A method to create a router for the scaffolder backend plugin.
+ * @public
+ */
 declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
 /** @public */
@@ -755,4 +741,4 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
-export { ActionContext, CompletedTaskState, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, DispatchResult, OctokitProvider, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, Status, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskState, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, executeShellCommand, fetchContents, runCommand };
+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 };

package/migrations/20210120143715_init.js

@@ -75,7 +75,7 @@ exports.up = async function up(knex) {
  * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
-  if (knex.client.config.client !== 'sqlite3') {
+  if (!knex.client.config.client.includes('sqlite3')) {
     await knex.schema.alterTable('task_events', table => {
       table.dropIndex([], 'task_events_task_id_idx');
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
   "description": "The Backstage backend plugin that helps you create new things",
-  "version": "0.17.3",
+  "version": "1.0.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -34,16 +34,15 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.12.0",
-    "@backstage/catalog-client": "^0.8.0",
-    "@backstage/catalog-model": "^0.12.0",
-    "@backstage/config": "^0.1.15",
-    "@backstage/errors": "^0.2.2",
-    "@backstage/integration": "^0.8.0",
-    "@backstage/plugin-catalog-backend": "^0.23.0",
-    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.2.3",
-    "@backstage/plugin-scaffolder-common": "^0.2.3",
-    "@backstage/types": "^0.1.3",
+    "@backstage/backend-common": "^0.13.1",
+    "@backstage/catalog-client": "^1.0.0",
+    "@backstage/catalog-model": "^1.0.0",
+    "@backstage/config": "^1.0.0",
+    "@backstage/errors": "^1.0.0",
+    "@backstage/integration": "^1.0.0",
+    "@backstage/plugin-catalog-backend": "^1.0.0",
+    "@backstage/plugin-scaffolder-common": "^1.0.0",
+    "@backstage/types": "^1.0.0",
     "@gitbeaker/core": "^34.6.0",
     "@gitbeaker/node": "^35.1.0",
     "@octokit/webhooks": "^9.14.1",
@@ -54,10 +53,9 @@
     "cors": "^2.8.5",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
-    "fs-extra": "10.0.0",
+    "fs-extra": "10.0.1",
     "git-url-parse": "^11.6.0",
     "globby": "^11.0.0",
-    "handlebars": "^4.7.6",
     "isbinaryfile": "^4.0.8",
     "isomorphic-git": "^1.8.0",
     "jsonschema": "^1.2.6",
@@ -76,8 +74,8 @@
     "zen-observable": "^0.8.15"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.15.0",
-    "@backstage/test-utils": "^0.3.0",
+    "@backstage/backend-test-utils": "^0.1.22",
+    "@backstage/cli": "^0.16.0",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -99,5 +97,5 @@
     "assets"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "04bb0dd824b78f6b57dac62c3015e681f094045c"
+  "gitHead": "e9496f746b31600dbfac7fa76987479e66426257"
 }