@backstage/plugin-scaffolder-backend 0.17.2 → 0.17.3

package/dist/index.d.ts

@@ -17,6 +17,10 @@ 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 +33,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;
 
 /**
@@ -219,6 +228,9 @@ 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.
@@ -241,6 +253,7 @@ declare type ActionContext<Input extends JsonObject> = {
     metadata?: TemplateMetadata;
     templateInfo?: TemplateInfo;
 };
+/** @public */
 declare type TemplateAction<Input extends JsonObject> = {
     id: string;
     description?: string;
@@ -274,14 +287,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 +314,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 +348,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 +368,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 +384,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 +406,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;
@@ -384,15 +443,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 +460,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 +480,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 +497,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 +514,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 +531,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;
@@ -496,6 +580,7 @@ declare class OctokitProvider {
     }): Promise<OctokitIntegration>;
 }
 
+/** @public */
 declare type RunCommandOptions = {
     /** command to run */
     command: string;
@@ -519,6 +604,10 @@ declare const executeShellCommand: (options: RunCommandOptions) => Promise<void>
  */
 declare const runCommand: (options: RunCommandOptions) => Promise<void>;
 
+/**
+ * Registry of all registered template actions.
+ * @public
+ */
 declare class TemplateActionRegistry {
     private readonly actions;
     register<TInput extends JsonObject>(action: TemplateAction<TInput>): void;
@@ -526,6 +615,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>;
 
 /**
@@ -651,6 +744,7 @@ interface RouterOptions {
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
 }
+/** @public */
 declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
 /** @public */
@@ -661,4 +755,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, 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 };

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.17.3",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -34,15 +34,15 @@
     "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.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.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.23.0",
+    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.2.3",
+    "@backstage/plugin-scaffolder-common": "^0.2.3",
     "@backstage/types": "^0.1.3",
     "@gitbeaker/core": "^34.6.0",
     "@gitbeaker/node": "^35.1.0",
@@ -76,8 +76,8 @@
     "zen-observable": "^0.8.15"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.14.1",
-    "@backstage/test-utils": "^0.2.6",
+    "@backstage/cli": "^0.15.0",
+    "@backstage/test-utils": "^0.3.0",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -99,5 +99,5 @@
     "assets"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "ec2472ce819b110dc9515f66275b77be83f77219"
+  "gitHead": "04bb0dd824b78f6b57dac62c3015e681f094045c"
 }