@backstage/plugin-scaffolder-backend 1.5.1 → 1.6.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,76 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.6.0-next.2
+
+### Minor Changes
+
+- d1f7ba58e3: Added `repositoryId` output when create a repository in Azure
+
+### Patch Changes
+
+- eadf56bbbf: Bump `git-url-parse` version to `^13.0.0`
+- 096631e571: Added support for handling broken symlinks within the scaffolder backend. This is intended for templates that may hold a symlink that is invalid at build time but valid within the destination repo.
+- 667d917488: Updated dependency `msw` to `^0.47.0`.
+- 87ec2ba4d6: Updated dependency `msw` to `^0.46.0`.
+- 6b9f6c0a4d: Added alpha `scaffolderPlugin` to be used with experimental backend system.
+- 83c037cd46: Disable octokit throttling in publish:github:pull-request
+- 2cbd533426: Uptake the `IdentityApi` change to use `getIdentity` instead of `authenticate` for retrieving the logged in users identity.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.1.2-next.1
+  - @backstage/plugin-catalog-node@1.0.2-next.1
+  - @backstage/backend-common@0.15.1-next.2
+  - @backstage/integration@1.3.1-next.1
+  - @backstage/plugin-catalog-backend@1.4.0-next.2
+  - @backstage/plugin-auth-node@0.2.5-next.2
+  - @backstage/catalog-client@1.0.5-next.1
+
+## 1.6.0-next.1
+
+### Minor Changes
+
+- 7db9613671: Added `projectId` for gitlab projects to be displayed in the `gitlab:publish` output
+
+### Patch Changes
+
+- 0d8d650e32: Applied the fix from version 1.5.1 of this package, which is part of the v1.5.1 release of Backstage.
+- Updated dependencies
+  - @backstage/backend-common@0.15.1-next.1
+  - @backstage/plugin-catalog-backend@1.4.0-next.1
+
+## 1.6.0-next.0
+
+### Minor Changes
+
+- ea2eee9e6a: Add the option for a homepage when using the `github:publish` action
+- 8872cc735d: Fixed a bug in plugin-scaffolder-backend where it ignores the skip migration database options.
+
+  To use this new implementation you need to create the instance of `DatabaseTaskStore` using the `PluginDatabaseManager` instead of `Knex`;
+
+  ```
+  import { DatabaseManager, getRootLogger, loadBackendConfig } from '@backstage/backend-common';
+  import { DatabaseTaskStore } from '@backstage/plugin-scaffolder-backend';
+
+  const config = await loadBackendConfig({ argv: process.argv, logger: getRootLogger() });
+  const databaseManager = DatabaseManager.fromConfig(config, { migrations: { skip: true } });
+  const databaseTaskStore = await DatabaseTaskStore.create(databaseManager);
+  ```
+
+- 1ff817b3f0: add entity metadata to the template info type
+
+### Patch Changes
+
+- bf5e9030eb: Updated dependency `msw` to `^0.45.0`.
+- 2df9955f4a: Removed the depreacated `publish:file` action, use the template editor to test templates instead.
+- ef9ab322de: Minor API signatures cleanup
+- Updated dependencies
+  - @backstage/backend-common@0.15.1-next.0
+  - @backstage/plugin-catalog-backend@1.3.2-next.0
+  - @backstage/backend-plugin-api@0.1.2-next.0
+  - @backstage/catalog-client@1.0.5-next.0
+  - @backstage/integration@1.3.1-next.0
+  - @backstage/plugin-scaffolder-common@1.2.0-next.0
+  - @backstage/plugin-catalog-node@1.0.2-next.0
+
 ## 1.5.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.5.1",
+  "version": "1.6.0-next.2",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -15,6 +15,7 @@ import { createPullRequest } from 'octokit-plugin-create-pull-request';
 import { Entity } from '@backstage/catalog-model';
 import express from 'express';
 import { GithubCredentialsProvider } from '@backstage/integration';
+import { IdentityApi } from '@backstage/plugin-auth-node';
 import { JsonObject } from '@backstage/types';
 import { JsonValue } from '@backstage/types';
 import { Knex } from 'knex';
@@ -264,6 +265,7 @@ export declare function createGithubRepoCreateAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 description?: string | undefined;
+homepage?: string | undefined;
 access?: string | undefined;
 deleteBranchOnMerge?: boolean | undefined;
 gitAuthorName?: string | undefined;
@@ -409,22 +411,6 @@ enableLFS?: boolean | undefined;
 token?: string | undefined;
 }>;
 
-/**
- * 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
- * @deprecated This action will be removed, prefer testing templates using the template editor instead.
- */
-export 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.
@@ -472,6 +458,7 @@ export declare function createPublishGithubAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 description?: string | undefined;
+homepage?: string | undefined;
 access?: string | undefined;
 defaultBranch?: string | undefined;
 protectDefaultBranch?: boolean | undefined;
@@ -619,6 +606,8 @@ export declare interface CurrentClaimedTask {
 export declare class DatabaseTaskStore implements TaskStore {
     private readonly db;
     static create(options: DatabaseTaskStoreOptions): Promise<DatabaseTaskStore>;
+    private static getClient;
+    private static runMigrations;
     private constructor();
     list(options: {
         createdBy?: string;
@@ -629,14 +618,14 @@ export declare class DatabaseTaskStore implements TaskStore {
     createTask(options: TaskStoreCreateTaskOptions): Promise<TaskStoreCreateTaskResult>;
     claimTask(): Promise<SerializedTask | undefined>;
     heartbeatTask(taskId: string): Promise<void>;
-    listStaleTasks({ timeoutS }: {
+    listStaleTasks(options: {
         timeoutS: number;
     }): Promise<{
         tasks: {
             taskId: string;
         }[];
     }>;
-    completeTask({ taskId, status, eventBody, }: {
+    completeTask(options: {
         taskId: string;
         status: TaskStatus;
         eventBody: JsonObject;
@@ -644,7 +633,7 @@ export declare class DatabaseTaskStore implements TaskStore {
     emitLogEvent(options: TaskStoreEmitOptions<{
         message: string;
     } & JsonObject>): Promise<void>;
-    listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
+    listEvents(options: TaskStoreListEventsOptions): Promise<{
         events: SerializedTaskEvent[];
     }>;
 }
@@ -655,7 +644,7 @@ export declare class DatabaseTaskStore implements TaskStore {
  * @public
  */
 export declare type DatabaseTaskStoreOptions = {
-    database: Knex;
+    database: PluginDatabaseManager | Knex;
 };
 
 /**
@@ -671,7 +660,7 @@ export declare const executeShellCommand: (options: RunCommandOptions) => Promis
  *
  * @public
  */
-export declare function fetchContents({ reader, integrations, baseUrl, fetchUrl, outputPath, }: {
+export declare function fetchContents(options: {
     reader: UrlReader;
     integrations: ScmIntegrations;
     baseUrl?: string;
@@ -704,6 +693,7 @@ export declare interface RouterOptions {
     taskWorkers?: number;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    identity?: IdentityApi;
 }
 
 /** @public */
@@ -722,7 +712,7 @@ export declare type RunCommandOptions = {
  * @alpha
  * Registers the ScaffolderEntitiesProcessor with the catalog processing extension point.
  */
-export declare const scaffolderCatalogModule: (options?: unknown) => BackendFeature;
+export declare const scaffolderCatalogModule: (options?: undefined) => BackendFeature;
 
 /** @public */
 export declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
@@ -732,6 +722,23 @@ export declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
+/**
+ * Catalog plugin
+ * @alpha
+ */
+export declare const scaffolderPlugin: (options: ScaffolderPluginOptions) => BackendFeature;
+
+/**
+ * Catalog plugin options
+ * @alpha
+ */
+export declare type ScaffolderPluginOptions = {
+    actions?: TemplateAction<any>[];
+    taskWorkers?: number;
+    taskBroker?: TaskBroker;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
+};
+
 /**
  * SerializedTask
  *

package/dist/index.beta.d.ts

@@ -15,6 +15,7 @@ import { createPullRequest } from 'octokit-plugin-create-pull-request';
 import { Entity } from '@backstage/catalog-model';
 import express from 'express';
 import { GithubCredentialsProvider } from '@backstage/integration';
+import { IdentityApi } from '@backstage/plugin-auth-node';
 import { JsonObject } from '@backstage/types';
 import { JsonValue } from '@backstage/types';
 import { Knex } from 'knex';
@@ -264,6 +265,7 @@ export declare function createGithubRepoCreateAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 description?: string | undefined;
+homepage?: string | undefined;
 access?: string | undefined;
 deleteBranchOnMerge?: boolean | undefined;
 gitAuthorName?: string | undefined;
@@ -409,22 +411,6 @@ enableLFS?: boolean | undefined;
 token?: string | undefined;
 }>;
 
-/**
- * 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
- * @deprecated This action will be removed, prefer testing templates using the template editor instead.
- */
-export 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.
@@ -472,6 +458,7 @@ export declare function createPublishGithubAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 description?: string | undefined;
+homepage?: string | undefined;
 access?: string | undefined;
 defaultBranch?: string | undefined;
 protectDefaultBranch?: boolean | undefined;
@@ -619,6 +606,8 @@ export declare interface CurrentClaimedTask {
 export declare class DatabaseTaskStore implements TaskStore {
     private readonly db;
     static create(options: DatabaseTaskStoreOptions): Promise<DatabaseTaskStore>;
+    private static getClient;
+    private static runMigrations;
     private constructor();
     list(options: {
         createdBy?: string;
@@ -629,14 +618,14 @@ export declare class DatabaseTaskStore implements TaskStore {
     createTask(options: TaskStoreCreateTaskOptions): Promise<TaskStoreCreateTaskResult>;
     claimTask(): Promise<SerializedTask | undefined>;
     heartbeatTask(taskId: string): Promise<void>;
-    listStaleTasks({ timeoutS }: {
+    listStaleTasks(options: {
         timeoutS: number;
     }): Promise<{
         tasks: {
             taskId: string;
         }[];
     }>;
-    completeTask({ taskId, status, eventBody, }: {
+    completeTask(options: {
         taskId: string;
         status: TaskStatus;
         eventBody: JsonObject;
@@ -644,7 +633,7 @@ export declare class DatabaseTaskStore implements TaskStore {
     emitLogEvent(options: TaskStoreEmitOptions<{
         message: string;
     } & JsonObject>): Promise<void>;
-    listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
+    listEvents(options: TaskStoreListEventsOptions): Promise<{
         events: SerializedTaskEvent[];
     }>;
 }
@@ -655,7 +644,7 @@ export declare class DatabaseTaskStore implements TaskStore {
  * @public
  */
 export declare type DatabaseTaskStoreOptions = {
-    database: Knex;
+    database: PluginDatabaseManager | Knex;
 };
 
 /**
@@ -671,7 +660,7 @@ export declare const executeShellCommand: (options: RunCommandOptions) => Promis
  *
  * @public
  */
-export declare function fetchContents({ reader, integrations, baseUrl, fetchUrl, outputPath, }: {
+export declare function fetchContents(options: {
     reader: UrlReader;
     integrations: ScmIntegrations;
     baseUrl?: string;
@@ -704,6 +693,7 @@ export declare interface RouterOptions {
     taskWorkers?: number;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    identity?: IdentityApi;
 }
 
 /** @public */
@@ -728,6 +718,10 @@ export declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
+/* Excluded from this release type: scaffolderPlugin */
+
+/* Excluded from this release type: ScaffolderPluginOptions */
+
 /**
  * SerializedTask
  *