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

package/CHANGELOG.md

@@ -1,5 +1,82 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.7.0-next.0
+
+### Minor Changes
+
+- 253453fa14: Added a new property called `additionalTemplateGlobals` which allows you to add global functions to the scaffolder nunjucks templates.
+- 304305dd20: Add `allowAutoMerge` option for `publish:github` action
+- 694bfe2d61: Add functionality to shutdown scaffolder tasks if they are stale
+
+### Patch Changes
+
+- b681275e69: Ignore .git directories in Template Editor, increase upload limit for dry-runs to 10MB.
+- Updated dependencies
+  - @backstage/catalog-model@1.1.2-next.0
+  - @backstage/backend-plugin-api@0.1.3-next.0
+  - @backstage/plugin-catalog-backend@1.4.1-next.0
+  - @backstage/catalog-client@1.1.1-next.0
+  - @backstage/plugin-catalog-node@1.1.1-next.0
+  - @backstage/plugin-scaffolder-common@1.2.1-next.0
+  - @backstage/backend-common@0.15.2-next.0
+  - @backstage/backend-tasks@0.3.6-next.0
+  - @backstage/plugin-auth-node@0.2.6-next.0
+  - @backstage/config@1.0.3-next.0
+  - @backstage/errors@1.1.2-next.0
+  - @backstage/integration@1.3.2-next.0
+  - @backstage/types@1.0.0
+
+## 1.6.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);
+  ```
+
+- 7db9613671: Added `projectId` for gitlab projects to be displayed in the `gitlab:publish` output
+- d1f7ba58e3: Added `repositoryId` output when create a repository in Azure
+- 1ff817b3f0: add entity metadata to the template info type
+
+### Patch Changes
+
+- eadf56bbbf: Bump `git-url-parse` version to `^13.0.0`
+- de8ee4afe3: Provide information about the user into scaffolder template action's context
+- 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.
+- 0d8d650e32: Applied the fix from version 1.5.1 of this package, which is part of the v1.5.1 release of Backstage.
+- 667d917488: Updated dependency `msw` to `^0.47.0`.
+- 87ec2ba4d6: Updated dependency `msw` to `^0.46.0`.
+- bf5e9030eb: Updated dependency `msw` to `^0.45.0`.
+- 2df9955f4a: Removed the depreacated `publish:file` action, use the template editor to test templates instead.
+- 0ecc9a6784: Properly set `ctx.isDryRun` when running actions in dry run mode. Also always log action inputs for debugging purposes when running in dry run mode.
+- 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.
+- ef9ab322de: Minor API signatures cleanup
+- 50467bc15b: The number of task workers used to execute templates now default to 3, rather than 1.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.1.2
+  - @backstage/backend-common@0.15.1
+  - @backstage/plugin-auth-node@0.2.5
+  - @backstage/plugin-catalog-node@1.1.0
+  - @backstage/integration@1.3.1
+  - @backstage/plugin-catalog-backend@1.4.0
+  - @backstage/catalog-client@1.1.0
+  - @backstage/catalog-model@1.1.1
+  - @backstage/config@1.0.2
+  - @backstage/errors@1.1.1
+  - @backstage/plugin-scaffolder-common@1.2.0
+
 ## 1.6.0-next.3
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -24,6 +24,7 @@ import { Logger } from 'winston';
 import { Observable } from '@backstage/types';
 import { Octokit } from 'octokit';
 import { PluginDatabaseManager } from '@backstage/backend-common';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
 import { Schema } from 'jsonschema';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { ScmIntegrations } from '@backstage/integration';
@@ -32,6 +33,7 @@ import { TaskSpec } from '@backstage/plugin-scaffolder-common';
 import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
 import { UrlReader } from '@backstage/backend-common';
+import { UserEntity } from '@backstage/catalog-model';
 import { Writable } from 'stream';
 
 /**
@@ -55,6 +57,19 @@ export declare type ActionContext<Input extends JsonObject> = {
      * This will only ever be true if the actions as marked as supporting dry-runs.
      */
     isDryRun?: boolean;
+    /**
+     * The user which triggered the action.
+     */
+    user?: {
+        /**
+         * The decorated entity from the Catalog
+         */
+        entity?: UserEntity;
+        /**
+         * An entity ref for the author of the task
+         */
+        ref?: string;
+    };
 };
 
 /**
@@ -92,6 +107,7 @@ export declare interface CreateBuiltInActionsOptions {
      * Template Manifests and also template skeleton files when using `fetch:template`.
      */
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 }
 
 /**
@@ -158,6 +174,7 @@ export declare function createFetchTemplateAction(options: {
     reader: UrlReader;
     integrations: ScmIntegrations;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 }): TemplateAction<    {
 url: string;
 targetPath?: string | undefined;
@@ -273,6 +290,7 @@ gitAuthorEmail?: string | undefined;
 allowRebaseMerge?: boolean | undefined;
 allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
+allowAutoMerge?: boolean | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
@@ -470,6 +488,7 @@ gitAuthorEmail?: string | undefined;
 allowRebaseMerge?: boolean | undefined;
 allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
+allowAutoMerge?: boolean | undefined;
 sourcePath?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
@@ -572,6 +591,7 @@ export declare type CreateWorkerOptions = {
     workingDirectory: string;
     logger: Logger;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 };
 
 /**
@@ -636,6 +656,7 @@ export declare class DatabaseTaskStore implements TaskStore {
     listEvents(options: TaskStoreListEventsOptions): Promise<{
         events: SerializedTaskEvent[];
     }>;
+    shutdownTask({ taskId }: TaskStoreShutDownTaskOptions): Promise<void>;
 }
 
 /**
@@ -689,10 +710,12 @@ export declare interface RouterOptions {
     reader: UrlReader;
     database: PluginDatabaseManager;
     catalogClient: CatalogApi;
+    scheduler?: PluginTaskScheduler;
     actions?: TemplateAction<any>[];
     taskWorkers?: number;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
     identity?: IdentityApi;
 }
 
@@ -737,6 +760,7 @@ export declare type ScaffolderPluginOptions = {
     taskWorkers?: number;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 };
 
 /**
@@ -913,6 +937,7 @@ export declare interface TaskStore {
     listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
         events: SerializedTaskEvent[];
     }>;
+    shutdownTask?({ taskId }: TaskStoreShutDownTaskOptions): Promise<void>;
 }
 
 /**
@@ -953,6 +978,15 @@ export declare type TaskStoreListEventsOptions = {
     after?: number | undefined;
 };
 
+/**
+ * TaskStoreShutDownTaskOptions
+ *
+ * @public
+ */
+export declare type TaskStoreShutDownTaskOptions = {
+    taskId: string;
+};
+
 /**
  * TaskWorker
  *
@@ -992,4 +1026,7 @@ export declare class TemplateActionRegistry {
 /** @public */
 export declare type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
 
+/** @public */
+export declare type TemplateGlobal = ((...args: JsonValue[]) => JsonValue | undefined) | JsonValue;
+
 export { }

package/dist/index.beta.d.ts

@@ -24,6 +24,7 @@ import { Logger } from 'winston';
 import { Observable } from '@backstage/types';
 import { Octokit } from 'octokit';
 import { PluginDatabaseManager } from '@backstage/backend-common';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
 import { Schema } from 'jsonschema';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { ScmIntegrations } from '@backstage/integration';
@@ -32,6 +33,7 @@ import { TaskSpec } from '@backstage/plugin-scaffolder-common';
 import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
 import { UrlReader } from '@backstage/backend-common';
+import { UserEntity } from '@backstage/catalog-model';
 import { Writable } from 'stream';
 
 /**
@@ -55,6 +57,19 @@ export declare type ActionContext<Input extends JsonObject> = {
      * This will only ever be true if the actions as marked as supporting dry-runs.
      */
     isDryRun?: boolean;
+    /**
+     * The user which triggered the action.
+     */
+    user?: {
+        /**
+         * The decorated entity from the Catalog
+         */
+        entity?: UserEntity;
+        /**
+         * An entity ref for the author of the task
+         */
+        ref?: string;
+    };
 };
 
 /**
@@ -92,6 +107,7 @@ export declare interface CreateBuiltInActionsOptions {
      * Template Manifests and also template skeleton files when using `fetch:template`.
      */
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 }
 
 /**
@@ -158,6 +174,7 @@ export declare function createFetchTemplateAction(options: {
     reader: UrlReader;
     integrations: ScmIntegrations;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 }): TemplateAction<    {
 url: string;
 targetPath?: string | undefined;
@@ -273,6 +290,7 @@ gitAuthorEmail?: string | undefined;
 allowRebaseMerge?: boolean | undefined;
 allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
+allowAutoMerge?: boolean | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
@@ -470,6 +488,7 @@ gitAuthorEmail?: string | undefined;
 allowRebaseMerge?: boolean | undefined;
 allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
+allowAutoMerge?: boolean | undefined;
 sourcePath?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
@@ -572,6 +591,7 @@ export declare type CreateWorkerOptions = {
     workingDirectory: string;
     logger: Logger;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 };
 
 /**
@@ -636,6 +656,7 @@ export declare class DatabaseTaskStore implements TaskStore {
     listEvents(options: TaskStoreListEventsOptions): Promise<{
         events: SerializedTaskEvent[];
     }>;
+    shutdownTask({ taskId }: TaskStoreShutDownTaskOptions): Promise<void>;
 }
 
 /**
@@ -689,10 +710,12 @@ export declare interface RouterOptions {
     reader: UrlReader;
     database: PluginDatabaseManager;
     catalogClient: CatalogApi;
+    scheduler?: PluginTaskScheduler;
     actions?: TemplateAction<any>[];
     taskWorkers?: number;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
     identity?: IdentityApi;
 }
 
@@ -896,6 +919,7 @@ export declare interface TaskStore {
     listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
         events: SerializedTaskEvent[];
     }>;
+    shutdownTask?({ taskId }: TaskStoreShutDownTaskOptions): Promise<void>;
 }
 
 /**
@@ -936,6 +960,15 @@ export declare type TaskStoreListEventsOptions = {
     after?: number | undefined;
 };
 
+/**
+ * TaskStoreShutDownTaskOptions
+ *
+ * @public
+ */
+export declare type TaskStoreShutDownTaskOptions = {
+    taskId: string;
+};
+
 /**
  * TaskWorker
  *
@@ -975,4 +1008,7 @@ export declare class TemplateActionRegistry {
 /** @public */
 export declare type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
 
+/** @public */
+export declare type TemplateGlobal = ((...args: JsonValue[]) => JsonValue | undefined) | JsonValue;
+
 export { }