From 09000c16636cb03e63996a07db9b50e1049ec2c0 Mon Sep 17 00:00:00 2001 From: blam Date: Wed, 16 Feb 2022 15:01:26 +0100 Subject: [PATCH] chore: updating api-reports for all packages Signed-off-by: blam --- .changeset/cool-ways-battle.md | 4 ++-- plugins/scaffolder-backend/api-report.md | 2 ++ plugins/scaffolder-common/api-report.md | 6 ++++-- plugins/scaffolder-common/src/TaskSpec.ts | 1 - 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.changeset/cool-ways-battle.md b/.changeset/cool-ways-battle.md index f3f2f4f7c0..264b8ca420 100644 --- a/.changeset/cool-ways-battle.md +++ b/.changeset/cool-ways-battle.md @@ -2,5 +2,5 @@ '@backstage/plugin-scaffolder-common': patch --- -- Deprecate `TaskSpecV1Beta3.metadata` in favour of the new `TaskSpecV1Beta3.templateInfo` -- Deprecate `TaskSpecV1Beta3.baseUrl` in favour of the new `TaskSpecV1Beta3.templateInfo.baseUrl` +**DEPRECATION** - Deprecate `TaskSpecV1Beta3.metadata` in favour of the new `TaskSpecV1Beta3.templateInfo` +**DEPRECATION** - Deprecate `TaskSpecV1Beta3.baseUrl` in favour of the new `TaskSpecV1Beta3.templateInfo.baseUrl` diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index ba16b5d4f0..b0e6a43be2 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -29,6 +29,7 @@ import { SpawnOptionsWithoutStdio } from 'child_process'; import { TaskSpec } from '@backstage/plugin-scaffolder-common'; import { TaskSpecV1beta2 } from '@backstage/plugin-scaffolder-common'; import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common'; +import { TemplateInfo } from '@backstage/plugin-scaffolder-common'; import { TemplateMetadata } from '@backstage/plugin-scaffolder-common'; import { UrlReader } from '@backstage/backend-common'; import { Writable } from 'stream'; @@ -46,6 +47,7 @@ export type ActionContext = { output(name: string, value: JsonValue): void; createTemporaryDirectory(): Promise; metadata?: TemplateMetadata; + templateInfo?: TemplateInfo; }; // @public diff --git a/plugins/scaffolder-common/api-report.md b/plugins/scaffolder-common/api-report.md index ba90a238f9..92935bd5bb 100644 --- a/plugins/scaffolder-common/api-report.md +++ b/plugins/scaffolder-common/api-report.md @@ -15,9 +15,9 @@ export type TaskSpec = TaskSpecV1beta2 | TaskSpecV1beta3; export interface TaskSpecV1beta2 { // (undocumented) apiVersion: 'backstage.io/v1beta2'; - // (undocumented) + // @deprecated (undocumented) baseUrl?: string; - // (undocumented) + // @deprecated (undocumented) metadata?: TemplateMetadata; // (undocumented) output: { @@ -26,6 +26,8 @@ export interface TaskSpecV1beta2 { // (undocumented) steps: TaskStep[]; // (undocumented) + templateInfo?: TemplateInfo; + // (undocumented) values: JsonObject; } diff --git a/plugins/scaffolder-common/src/TaskSpec.ts b/plugins/scaffolder-common/src/TaskSpec.ts index 09d46b7fbb..f0002ac0a5 100644 --- a/plugins/scaffolder-common/src/TaskSpec.ts +++ b/plugins/scaffolder-common/src/TaskSpec.ts @@ -67,7 +67,6 @@ export interface TaskSpecV1beta2 { output: { [name: string]: string }; /** @deprecated use templateInfo instead */ metadata?: TemplateMetadata; - templateInfo?: TemplateInfo; }