@backstage/plugin-scaffolder-backend 1.5.0-next.1 → 1.6.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,76 @@
 # @backstage/plugin-scaffolder-backend
 
+## 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.0
+
+### Minor Changes
+
+- c4b452e16a: Starting the implementation of the Wizard page for the `next` scaffolder plugin
+- 593dea6710: Add support for Basic Auth for Bitbucket Server.
+- 3b7930b3e5: Add support for Bearer Authorization header / token-based auth at Git commands.
+- 3f1316f1c5: User Bearer Authorization header at Git commands with token-based auth at Bitbucket Server.
+- eeff5046ae: Updated `publish:gitlab:merge-request` action to allow commit updates and deletes
+- 692d5d3405: Added `reviewers` and `teamReviewers` parameters to `publish:github:pull-request` action to add reviewers on the pull request created by the action
+
+### Patch Changes
+
+- fc8a5f797b: Add a `publish:gerrit:review` scaffolder action
+- c971afbf21: The `publish:file` action has been deprecated in favor of testing templates using the template editor instead. Note that this action is not and was never been installed by default.
+- b10b6c4aa4: Fix issue on Windows where templated files where not properly skipped as intended.
+- 56e1b4b89c: Fixed typos in alpha types.
+- dad0f65494: Fail gracefully if an invalid `Authorization` header is passed to `POST /v2/tasks`
+- 014b3b7776: Add missing `res.end()` in scaffolder backend `EventStream` usage
+- Updated dependencies
+  - @backstage/backend-common@0.15.0
+  - @backstage/backend-plugin-api@0.1.1
+  - @backstage/plugin-catalog-node@1.0.1
+  - @backstage/integration@1.3.0
+  - @backstage/plugin-catalog-backend@1.3.1
+
+## 1.5.0-next.2
+
+### Minor Changes
+
+- 692d5d3405: Added `reviewers` and `teamReviewers` parameters to `publish:github:pull-request` action to add reviewers on the pull request created by the action
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.3.1-next.2
+
 ## 1.5.0-next.1
 
 ### Minor Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -6,7 +6,7 @@
 
 /// <reference types="node" />
 
-import { BackendRegistrable } from '@backstage/backend-plugin-api';
+import { BackendFeature } from '@backstage/backend-plugin-api';
 import { CatalogApi } from '@backstage/catalog-client';
 import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
 import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
@@ -21,6 +21,7 @@ import { Knex } from 'knex';
 import { LocationSpec } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
 import { Observable } from '@backstage/types';
+import { Octokit } from 'octokit';
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { Schema } from 'jsonschema';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -263,6 +264,7 @@ export declare function createGithubRepoCreateAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 description?: string | undefined;
+homepage?: string | undefined;
 access?: string | undefined;
 deleteBranchOnMerge?: boolean | undefined;
 gitAuthorName?: string | undefined;
@@ -408,21 +410,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
- */
-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.
@@ -470,6 +457,7 @@ export declare function createPublishGithubAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 description?: string | undefined;
+homepage?: string | undefined;
 access?: string | undefined;
 defaultBranch?: string | undefined;
 protectDefaultBranch?: boolean | undefined;
@@ -513,6 +501,8 @@ draft?: boolean | undefined;
 targetPath?: string | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
+reviewers?: string[] | undefined;
+teamReviewers?: string[] | undefined;
 }>;
 
 /**
@@ -615,6 +605,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;
@@ -625,14 +617,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;
@@ -640,7 +632,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[];
     }>;
 }
@@ -651,7 +643,7 @@ export declare class DatabaseTaskStore implements TaskStore {
  * @public
  */
 export declare type DatabaseTaskStoreOptions = {
-    database: Knex;
+    database: PluginDatabaseManager | Knex;
 };
 
 /**
@@ -667,7 +659,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;
@@ -676,14 +668,14 @@ export declare function fetchContents({ reader, integrations, baseUrl, fetchUrl,
 }): Promise<void>;
 
 /** @public */
-export declare interface OctokitWithPullRequestPluginClient {
+export declare type OctokitWithPullRequestPluginClient = Octokit & {
     createPullRequest(options: createPullRequest.Options): Promise<{
         data: {
             html_url: string;
             number: number;
         };
     } | null>;
-}
+};
 
 /**
  * RouterOptions
@@ -718,7 +710,7 @@ export declare type RunCommandOptions = {
  * @alpha
  * Registers the ScaffolderEntitiesProcessor with the catalog processing extension point.
  */
-export declare const scaffolderCatalogModule: (option: unknown) => BackendRegistrable;
+export declare const scaffolderCatalogModule: (options?: unknown) => BackendFeature;
 
 /** @public */
 export declare class ScaffolderEntitiesProcessor implements CatalogProcessor {

package/dist/index.beta.d.ts

@@ -6,7 +6,7 @@
 
 /// <reference types="node" />
 
-import { BackendRegistrable } from '@backstage/backend-plugin-api';
+import { BackendFeature } from '@backstage/backend-plugin-api';
 import { CatalogApi } from '@backstage/catalog-client';
 import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
 import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
@@ -21,6 +21,7 @@ import { Knex } from 'knex';
 import { LocationSpec } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
 import { Observable } from '@backstage/types';
+import { Octokit } from 'octokit';
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { Schema } from 'jsonschema';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -263,6 +264,7 @@ export declare function createGithubRepoCreateAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 description?: string | undefined;
+homepage?: string | undefined;
 access?: string | undefined;
 deleteBranchOnMerge?: boolean | undefined;
 gitAuthorName?: string | undefined;
@@ -408,21 +410,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
- */
-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.
@@ -470,6 +457,7 @@ export declare function createPublishGithubAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 description?: string | undefined;
+homepage?: string | undefined;
 access?: string | undefined;
 defaultBranch?: string | undefined;
 protectDefaultBranch?: boolean | undefined;
@@ -513,6 +501,8 @@ draft?: boolean | undefined;
 targetPath?: string | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
+reviewers?: string[] | undefined;
+teamReviewers?: string[] | undefined;
 }>;
 
 /**
@@ -615,6 +605,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;
@@ -625,14 +617,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;
@@ -640,7 +632,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[];
     }>;
 }
@@ -651,7 +643,7 @@ export declare class DatabaseTaskStore implements TaskStore {
  * @public
  */
 export declare type DatabaseTaskStoreOptions = {
-    database: Knex;
+    database: PluginDatabaseManager | Knex;
 };
 
 /**
@@ -667,7 +659,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;
@@ -676,14 +668,14 @@ export declare function fetchContents({ reader, integrations, baseUrl, fetchUrl,
 }): Promise<void>;
 
 /** @public */
-export declare interface OctokitWithPullRequestPluginClient {
+export declare type OctokitWithPullRequestPluginClient = Octokit & {
     createPullRequest(options: createPullRequest.Options): Promise<{
         data: {
             html_url: string;
             number: number;
         };
     } | null>;
-}
+};
 
 /**
  * RouterOptions