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

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @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

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -264,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;
@@ -409,22 +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
- * @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 +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;
@@ -619,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;
@@ -629,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;
@@ -644,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[];
     }>;
 }
@@ -655,7 +643,7 @@ export declare class DatabaseTaskStore implements TaskStore {
  * @public
  */
 export declare type DatabaseTaskStoreOptions = {
-    database: Knex;
+    database: PluginDatabaseManager | Knex;
 };
 
 /**
@@ -671,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;

package/dist/index.beta.d.ts

@@ -264,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;
@@ -409,22 +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
- * @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 +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;
@@ -619,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;
@@ -629,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;
@@ -644,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[];
     }>;
 }
@@ -655,7 +643,7 @@ export declare class DatabaseTaskStore implements TaskStore {
  * @public
  */
 export declare type DatabaseTaskStoreOptions = {
-    database: Knex;
+    database: PluginDatabaseManager | Knex;
 };
 
 /**
@@ -671,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;

package/dist/index.cjs.js

@@ -283,13 +283,8 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-async function fetchContents({
-  reader,
-  integrations,
-  baseUrl,
-  fetchUrl = ".",
-  outputPath
-}) {
+async function fetchContents(options) {
+  const { reader, integrations, baseUrl, fetchUrl = ".", outputPath } = options;
   let fetchUrlIsAbsolute = false;
   try {
     new URL(fetchUrl);
@@ -1043,7 +1038,7 @@ async function getOctokitOptions(options) {
     previews: ["nebula-preview"]
   };
 }
-async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, repoVisibility, description, deleteBranchOnMerge, allowMergeCommit, allowSquashMerge, allowRebaseMerge, access, collaborators, topics, logger) {
+async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, repoVisibility, description, homepage, deleteBranchOnMerge, allowMergeCommit, allowSquashMerge, allowRebaseMerge, access, collaborators, topics, logger) {
   const user = await client.rest.users.getByUsername({
     username: owner
   });
@@ -1056,7 +1051,8 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
     delete_branch_on_merge: deleteBranchOnMerge,
     allow_merge_commit: allowMergeCommit,
     allow_squash_merge: allowSquashMerge,
-    allow_rebase_merge: allowRebaseMerge
+    allow_rebase_merge: allowRebaseMerge,
+    homepage
   }) : client.rest.repos.createForAuthenticatedUser({
     name: repo,
     private: repoVisibility === "private",
@@ -1064,7 +1060,8 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
     delete_branch_on_merge: deleteBranchOnMerge,
     allow_merge_commit: allowMergeCommit,
     allow_squash_merge: allowSquashMerge,
-    allow_rebase_merge: allowRebaseMerge
+    allow_rebase_merge: allowRebaseMerge,
+    homepage
   });
   let newRepo;
   try {
@@ -1335,6 +1332,10 @@ const description = {
   title: "Repository Description",
   type: "string"
 };
+const homepage = {
+  title: "Repository Homepage",
+  type: "string"
+};
 const access = {
   title: "Repository Access",
   description: `Sets an admin collaborator on the repository. Can either be a user reference different from 'owner' in 'repoUrl' or team reference, eg. 'org/team-name'`,
@@ -1473,6 +1474,7 @@ function createGithubRepoCreateAction(options) {
         properties: {
           repoUrl: repoUrl,
           description: description,
+          homepage: homepage,
           access: access,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
@@ -1498,6 +1500,7 @@ function createGithubRepoCreateAction(options) {
       const {
         repoUrl,
         description,
+        homepage,
         access,
         repoVisibility = "private",
         deleteBranchOnMerge = false,
@@ -1525,6 +1528,7 @@ function createGithubRepoCreateAction(options) {
         owner,
         repoVisibility,
         description,
+        homepage,
         deleteBranchOnMerge,
         allowMergeCommit,
         allowSquashMerge,
@@ -2544,37 +2548,6 @@ function createPublishBitbucketServerAction(options) {
   });
 }
 
-function createPublishFileAction() {
-  return createTemplateAction({
-    id: "publish:file",
-    description: "Writes contents of the workspace to a local directory",
-    schema: {
-      input: {
-        type: "object",
-        required: ["path"],
-        properties: {
-          path: {
-            title: "Path to a directory where the output will be written",
-            type: "string"
-          }
-        }
-      }
-    },
-    async handler(ctx) {
-      ctx.logger.warn(
-        "[DEPRECATED] This action will be removed, prefer testing templates using the template editor instead."
-      );
-      const { path: path$1 } = ctx.input;
-      const exists = await fs__default["default"].pathExists(path$1);
-      if (exists) {
-        throw new errors.InputError("Output path already exists");
-      }
-      await fs__default["default"].ensureDir(path.dirname(path$1));
-      await fs__default["default"].copy(ctx.workspacePath, path$1);
-    }
-  });
-}
-
 const createGerritProject = async (config, options) => {
   const { projectName, parent, owner, description } = options;
   const fetchOptions = {
@@ -2843,6 +2816,7 @@ function createPublishGithubAction(options) {
         properties: {
           repoUrl: repoUrl,
           description: description,
+          homepage: homepage,
           access: access,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
@@ -2875,6 +2849,7 @@ function createPublishGithubAction(options) {
       const {
         repoUrl,
         description,
+        homepage,
         access,
         requireCodeOwnerReviews = false,
         requiredStatusCheckContexts = [],
@@ -2910,6 +2885,7 @@ function createPublishGithubAction(options) {
         owner,
         repoVisibility,
         description,
+        homepage,
         deleteBranchOnMerge,
         allowMergeCommit,
         allowSquashMerge,
@@ -3639,6 +3615,9 @@ const migrationsDir = backendCommon.resolvePackagePath(
   "@backstage/plugin-scaffolder-backend",
   "migrations"
 );
+function isPluginDatabaseManager(opt) {
+  return opt.getClient !== void 0;
+}
 const parseSqlDateToIsoString = (input) => {
   if (typeof input === "string") {
     return luxon.DateTime.fromSQL(input, { zone: "UTC" }).toISO();
@@ -3647,13 +3626,33 @@ const parseSqlDateToIsoString = (input) => {
 };
 class DatabaseTaskStore {
   static async create(options) {
-    await options.database.migrate.latest({
-      directory: migrationsDir
-    });
-    return new DatabaseTaskStore(options);
+    const { database } = options;
+    const client = await this.getClient(database);
+    await this.runMigrations(database, client);
+    return new DatabaseTaskStore(client);
   }
-  constructor(options) {
-    this.db = options.database;
+  static async getClient(database) {
+    if (isPluginDatabaseManager(database)) {
+      return database.getClient();
+    }
+    return database;
+  }
+  static async runMigrations(database, client) {
+    var _a;
+    if (!isPluginDatabaseManager(database)) {
+      await client.migrate.latest({
+        directory: migrationsDir
+      });
+      return;
+    }
+    if (!((_a = database.migrations) == null ? void 0 : _a.skip)) {
+      await client.migrate.latest({
+        directory: migrationsDir
+      });
+    }
+  }
+  constructor(client) {
+    this.db = client;
   }
   async list(options) {
     const queryBuilder = this.db("tasks");
@@ -3752,7 +3751,8 @@ class DatabaseTaskStore {
       throw new errors.ConflictError(`No running task with taskId ${taskId} found`);
     }
   }
-  async listStaleTasks({ timeoutS }) {
+  async listStaleTasks(options) {
+    const { timeoutS } = options;
     const rawRows = await this.db("tasks").where("status", "processing").andWhere(
       "last_heartbeat_at",
       "<=",
@@ -3766,11 +3766,8 @@ class DatabaseTaskStore {
     }));
     return { tasks };
   }
-  async completeTask({
-    taskId,
-    status,
-    eventBody
-  }) {
+  async completeTask(options) {
+    const { taskId, status, eventBody } = options;
     let oldStatus;
     if (status === "failed" || status === "completed") {
       oldStatus = "processing";
@@ -3818,10 +3815,8 @@ class DatabaseTaskStore {
       body: serializedBody
     });
   }
-  async listEvents({
-    taskId,
-    after
-  }) {
+  async listEvents(options) {
+    const { taskId, after } = options;
     const rawEvents = await this.db("task_events").where({
       task_id: taskId
     }).andWhere((builder) => {
@@ -4468,9 +4463,7 @@ async function createRouter(options) {
   const integrations = integration.ScmIntegrations.fromConfig(config);
   let taskBroker;
   if (!options.taskBroker) {
-    const databaseTaskStore = await DatabaseTaskStore.create({
-      database: await database.getClient()
-    });
+    const databaseTaskStore = await DatabaseTaskStore.create({ database });
     taskBroker = new StorageTaskBroker(databaseTaskStore, logger);
   } else {
     taskBroker = options.taskBroker;
@@ -4604,7 +4597,10 @@ async function createRouter(options) {
           namespace,
           name: (_c = template.metadata) == null ? void 0 : _c.name
         }),
-        baseUrl
+        baseUrl,
+        entity: {
+          metadata: template.metadata
+        }
       }
     };
     const result = await taskBroker.dispatch({
@@ -4890,7 +4886,6 @@ exports.createPublishAzureAction = createPublishAzureAction;
 exports.createPublishBitbucketAction = createPublishBitbucketAction;
 exports.createPublishBitbucketCloudAction = createPublishBitbucketCloudAction;
 exports.createPublishBitbucketServerAction = createPublishBitbucketServerAction;
-exports.createPublishFileAction = createPublishFileAction;
 exports.createPublishGerritAction = createPublishGerritAction;
 exports.createPublishGerritReviewAction = createPublishGerritReviewAction;
 exports.createPublishGithubAction = createPublishGithubAction;