@backstage/plugin-scaffolder-backend 0.17.2 → 0.18.0

package/dist/index.d.ts

@@ -5,18 +5,21 @@ 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';
 import { CatalogProcessor, LocationSpec, CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
 
+/**
+ * Registers entities from a catalog descriptor file in the workspace into the software catalog.
+ * @public
+ */
 declare function createCatalogRegisterAction(options: {
     catalogClient: CatalogApi;
     integrations: ScmIntegrations;
@@ -29,11 +32,16 @@ declare function createCatalogRegisterAction(options: {
     optional?: boolean | undefined;
 }>;
 
+/**
+ * Writes a catalog descriptor file containing the provided entity to a path in the workspace.
+ * @public
+ */
 declare function createCatalogWriteAction(): TemplateAction<{
     filePath?: string | undefined;
     entity: Entity;
 }>;
 
+/** @public */
 declare type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
 
 /**
@@ -42,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
  *
@@ -119,13 +113,6 @@ declare type TaskBrokerDispatchOptions = {
     spec: TaskSpec;
     secrets?: TaskSecrets;
 };
-/**
- * DispatchResult
- *
- * @public
- * @deprecated use TaskBrokerDispatchResult instead
- */
-declare type DispatchResult = TaskBrokerDispatchResult;
 /**
  * Task
  *
@@ -219,12 +206,11 @@ interface TaskStore {
     }>;
 }
 
+/**
+ * ActionContext is passed into scaffolder actions.
+ * @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;
@@ -235,12 +221,9 @@ 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 */
 declare type TemplateAction<Input extends JsonObject> = {
     id: string;
     description?: string;
@@ -259,8 +242,6 @@ interface CreateBuiltInActionsOptions {
     reader: UrlReader;
     integrations: ScmIntegrations;
     catalogClient: CatalogApi;
-    /** @deprecated when the cookiecutter action is removed this won't be necessary */
-    containerRunner?: ContainerRunner;
     config: Config;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
 }
@@ -274,14 +255,25 @@ interface CreateBuiltInActionsOptions {
 declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => TemplateAction<JsonObject>[];
 
 /**
+ * Writes a message into the log or lists all files in the workspace
+ *
+ * @remarks
+ *
  * This task is useful for local development and testing of both the scaffolder
  * and scaffolder templates.
+ *
+ * @public
  */
 declare function createDebugLogAction(): TemplateAction<{
     message?: string | undefined;
     listWorkspace?: boolean | undefined;
 }>;
 
+/**
+ * Downloads content and places it in the workspace, or optionally
+ * in a subdirectory specified by the 'targetPath' input option.
+ * @public
+ */
 declare function createFetchPlainAction(options: {
     reader: UrlReader;
     integrations: ScmIntegrations;
@@ -290,6 +282,13 @@ declare function createFetchPlainAction(options: {
     targetPath?: string | undefined;
 }>;
 
+/**
+ * Downloads a skeleton, templates variables into file and directory names and content.
+ * Then places the result in the workspace, or optionally in a subdirectory
+ * specified by the 'targetPath' input option.
+ *
+ * @public
+ */
 declare function createFetchTemplateAction(options: {
     reader: UrlReader;
     integrations: ScmIntegrations;
@@ -317,10 +316,18 @@ declare function fetchContents({ reader, integrations, baseUrl, fetchUrl, output
     outputPath: string;
 }): Promise<void>;
 
+/**
+ * Creates new action that enables deletion of files and directories in the workspace.
+ * @public
+ */
 declare const createFilesystemDeleteAction: () => TemplateAction<{
     files: string[];
 }>;
 
+/**
+ * Creates a new action that allows renames of files and directories in the workspace.
+ * @public
+ */
 declare const createFilesystemRenameAction: () => TemplateAction<{
     files: Array<{
         from: string;
@@ -329,6 +336,11 @@ declare const createFilesystemRenameAction: () => TemplateAction<{
     }>;
 }>;
 
+/**
+ * Creates a new action that initializes a git repository of the content in the workspace
+ * and publishes it to Azure.
+ * @public
+ */
 declare function createPublishAzureAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
@@ -340,6 +352,11 @@ declare function createPublishAzureAction(options: {
     token?: string | undefined;
 }>;
 
+/**
+ * Creates a new action that initializes a git repository of the content in the workspace
+ * and publishes it to Bitbucket.
+ * @public
+ */
 declare function createPublishBitbucketAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
@@ -357,13 +374,23 @@ declare function createPublishBitbucketAction(options: {
  * This task is useful for local development and testing of both the scaffolder
  * and scaffolder templates.
  *
+ * @remarks
+ *
  * This action is not installed by default and should not be installed in
  * production, as it writes the files to the local filesystem of the scaffolder.
+ *
+ * @public
  */
 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 GitHub.
+ *
+ * @public
+ */
 declare function createPublishGithubAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
@@ -373,6 +400,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;
@@ -384,15 +415,16 @@ declare function createPublishGithubAction(options: {
     topics?: string[] | undefined;
 }>;
 
-declare type CreatePullRequestResponse = {
-    data: {
-        html_url: string;
-    };
-};
-interface PullRequestCreator {
-    createPullRequest(options: createPullRequest.Options): Promise<CreatePullRequestResponse | null>;
+/** @public */
+interface OctokitWithPullRequestPluginClient {
+    createPullRequest(options: createPullRequest.Options): Promise<{
+        data: {
+            html_url: string;
+        };
+    } | null>;
 }
-declare type ClientFactoryInput = {
+/** @public */
+declare type CreateGithubPullRequestClientFactoryInput = {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
     host: string;
@@ -400,11 +432,16 @@ declare type ClientFactoryInput = {
     repo: string;
     token?: string;
 };
+/** @public */
 interface CreateGithubPullRequestActionOptions {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
-    clientFactory?: (input: ClientFactoryInput) => Promise<PullRequestCreator>;
+    clientFactory?: (input: CreateGithubPullRequestClientFactoryInput) => Promise<OctokitWithPullRequestPluginClient>;
 }
+/**
+ * Creates a Github Pull Request action.
+ * @public
+ */
 declare const createPublishGithubPullRequestAction: ({ integrations, githubCredentialsProvider, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction<{
     title: string;
     branchName: string;
@@ -415,6 +452,12 @@ declare const createPublishGithubPullRequestAction: ({ integrations, githubCrede
     token?: string | undefined;
 }>;
 
+/**
+ * Creates a new action that initializes a git repository of the content in the workspace
+ * and publishes it to GitLab.
+ *
+ * @public
+ */
 declare function createPublishGitlabAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
@@ -426,6 +469,11 @@ declare function createPublishGitlabAction(options: {
     token?: string | undefined;
 }>;
 
+/**
+ * Create a new action that creates a gitlab merge request.
+ *
+ * @public
+ */
 declare const createPublishGitlabMergeRequestAction: (options: {
     integrations: ScmIntegrationRegistry;
 }) => TemplateAction<{
@@ -438,6 +486,10 @@ declare const createPublishGitlabMergeRequestAction: (options: {
     token?: string | undefined;
 }>;
 
+/**
+ * Creates a new action that dispatches a GitHub Action workflow for a given branch or tag.
+ * @public
+ */
 declare function createGithubActionsDispatchAction(options: {
     integrations: ScmIntegrations;
     githubCredentialsProvider?: GithubCredentialsProvider;
@@ -451,6 +503,10 @@ declare function createGithubActionsDispatchAction(options: {
     token?: string | undefined;
 }>;
 
+/**
+ * Creates new action that creates a webhook for a repository on GitHub.
+ * @public
+ */
 declare function createGithubWebhookAction(options: {
     integrations: ScmIntegrationRegistry;
     defaultWebhookSecret?: string;
@@ -466,36 +522,7 @@ 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
- */
-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>;
-}
-
+/** @public */
 declare type RunCommandOptions = {
     /** command to run */
     command: string;
@@ -512,13 +539,11 @@ declare type RunCommandOptions = {
  * @public
  */
 declare const executeShellCommand: (options: RunCommandOptions) => Promise<void>;
+
 /**
- * Run a command in a sub-process, normally a shell command.
+ * Registry of all registered template actions.
  * @public
- * @deprecated use {@link executeShellCommand} instead
  */
-declare const runCommand: (options: RunCommandOptions) => Promise<void>;
-
 declare class TemplateActionRegistry {
     private readonly actions;
     register<TInput extends JsonObject>(action: TemplateAction<TInput>): void;
@@ -526,6 +551,10 @@ declare class TemplateActionRegistry {
     list(): TemplateAction<JsonObject>[];
 }
 
+/**
+ * This function is used to create new template actions to get type safety.
+ * @public
+ */
 declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
 
 /**
@@ -582,7 +611,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;
@@ -600,13 +629,6 @@ interface CurrentClaimedTask {
     taskId: string;
     secrets?: TaskSecrets;
 }
-/**
- * TaskState
- *
- * @public
- * @deprecated use CurrentClaimedTask instead
- */
-declare type TaskState = CurrentClaimedTask;
 
 /**
  * CreateWorkerOptions
@@ -647,10 +669,10 @@ interface RouterOptions {
     catalogClient: CatalogApi;
     actions?: TemplateAction<any>[];
     taskWorkers?: number;
-    containerRunner?: ContainerRunner;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
 }
+/** @public */
 declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
 /** @public */
@@ -661,4 +683,4 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
-export { ActionContext, CompletedTaskState, CreateBuiltInActionsOptions, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DispatchResult, OctokitProvider, RouterOptions, 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, 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.2",
+  "version": "0.18.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -34,15 +34,14 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.11.0",
-    "@backstage/catalog-client": "^0.7.2",
-    "@backstage/catalog-model": "^0.11.0",
+    "@backstage/backend-common": "^0.13.0",
+    "@backstage/catalog-client": "^0.9.0",
+    "@backstage/catalog-model": "^0.13.0",
     "@backstage/config": "^0.1.15",
     "@backstage/errors": "^0.2.2",
-    "@backstage/integration": "^0.7.5",
-    "@backstage/plugin-catalog-backend": "^0.22.0",
-    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.2.2",
-    "@backstage/plugin-scaffolder-common": "^0.2.2",
+    "@backstage/integration": "^0.8.0",
+    "@backstage/plugin-catalog-backend": "^0.24.0",
+    "@backstage/plugin-scaffolder-common": "^0.3.0",
     "@backstage/types": "^0.1.3",
     "@gitbeaker/core": "^34.6.0",
     "@gitbeaker/node": "^35.1.0",
@@ -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.14.1",
-    "@backstage/test-utils": "^0.2.6",
+    "@backstage/backend-test-utils": "^0.1.21",
+    "@backstage/cli": "^0.15.2",
     "@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": "ec2472ce819b110dc9515f66275b77be83f77219"
+  "gitHead": "60c4e39d1fcaeb10d6488ada1d907f34dc2a105a"
 }