From b61503b2ba0ca8c75045db71713611586c143cec Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 25 Jun 2024 14:41:42 +0200 Subject: [PATCH] feat: fix up the branch Signed-off-by: blam --- .../src/providers/GcpBucketWorkspaceProvider.ts | 2 +- .../scaffolder-backend/src/ScaffolderPlugin.ts | 6 +++--- .../src/scaffolder/tasks/DatabaseTaskStore.ts | 2 +- plugins/scaffolder-node/api-report-alpha.md | 13 +++++++++++++ plugins/scaffolder-node/api-report.md | 6 ------ plugins/scaffolder-node/src/alpha.ts | 2 ++ plugins/scaffolder-node/src/tasks/alpha.ts | 16 ++++++++++++++++ plugins/scaffolder-node/src/tasks/index.ts | 2 -- 8 files changed, 36 insertions(+), 13 deletions(-) create mode 100644 plugins/scaffolder-node/src/tasks/alpha.ts diff --git a/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts b/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts index 3d269f690e..3529073648 100644 --- a/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts +++ b/plugins/scaffolder-backend-module-gcp/src/providers/GcpBucketWorkspaceProvider.ts @@ -24,7 +24,7 @@ import { LoggerService } from '@backstage/backend-plugin-api'; import { serializeWorkspace, restoreWorkspace, -} from '@backstage/plugin-scaffolder-node'; +} from '@backstage/plugin-scaffolder-node/alpha'; export class GcpBucketWorkspaceProvider implements WorkspaceProvider { static create(logger: LoggerService, config?: Config) { diff --git a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts index 50e0dff9c0..27b4f6b196 100644 --- a/plugins/scaffolder-backend/src/ScaffolderPlugin.ts +++ b/plugins/scaffolder-backend/src/ScaffolderPlugin.ts @@ -86,17 +86,17 @@ export const scaffolderPlugin = createBackendPlugin({ }, }); -<<<<<<< HEAD const autocompleteHandlers: Record = {}; env.registerExtensionPoint(scaffolderAutocompleteExtensionPoint, { addAutocompleteProvider(provider) { autocompleteHandlers[provider.id] = provider.handler; -======= + }, + }); + const additionalWorkspaceProviders: Record = {}; env.registerExtensionPoint(scaffolderWorkspaceProviderExtensionPoint, { addProviders(provider) { Object.assign(additionalWorkspaceProviders, provider); ->>>>>>> 801e5ff2007a (Storing the serialized workspace into google cloud bucket) }, }); diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts index a4447c5dc0..fe62572af9 100644 --- a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts +++ b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts @@ -43,7 +43,7 @@ import { intervalFromNowTill } from './dbUtil'; import { restoreWorkspace, serializeWorkspace, -} from '@backstage/plugin-scaffolder-node'; +} from '@backstage/plugin-scaffolder-node/alpha'; const migrationsDir = resolvePackagePath( '@backstage/plugin-scaffolder-backend', diff --git a/plugins/scaffolder-node/api-report-alpha.md b/plugins/scaffolder-node/api-report-alpha.md index 9601d73215..c9b8130f0e 100644 --- a/plugins/scaffolder-node/api-report-alpha.md +++ b/plugins/scaffolder-node/api-report-alpha.md @@ -3,6 +3,8 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +/// + import { ExtensionPoint } from '@backstage/backend-plugin-api'; import { TaskBroker } from '@backstage/plugin-scaffolder-node'; import { TemplateAction } from '@backstage/plugin-scaffolder-node'; @@ -24,6 +26,12 @@ export type AutocompleteHandler = ({ }[]; }>; +// @alpha +export const restoreWorkspace: (opts: { + path: string; + buffer?: Buffer; +}) => Promise; + // @alpha export interface ScaffolderActionsExtensionPoint { // (undocumented) @@ -77,6 +85,11 @@ export interface ScaffolderWorkspaceProviderExtensionPoint { // @alpha export const scaffolderWorkspaceProviderExtensionPoint: ExtensionPoint; +// @alpha +export const serializeWorkspace: (opts: { path: string }) => Promise<{ + contents: Buffer; +}>; + // @alpha export interface WorkspaceProvider { // (undocumented) diff --git a/plugins/scaffolder-node/api-report.md b/plugins/scaffolder-node/api-report.md index 9e9a31a991..66e8ccd678 100644 --- a/plugins/scaffolder-node/api-report.md +++ b/plugins/scaffolder-node/api-report.md @@ -256,9 +256,6 @@ export const parseRepoUrl: ( project?: string | undefined; }; -// @public -export const restoreWorkspace: (path: string, buffer?: Buffer) => Promise; - // @public (undocumented) export interface SerializedFile { // (undocumented) @@ -301,9 +298,6 @@ export type SerializedTaskEvent = { createdAt: string; }; -// @public -export const serializeWorkspace: (path: string) => Promise; - // @public export interface TaskBroker { // (undocumented) diff --git a/plugins/scaffolder-node/src/alpha.ts b/plugins/scaffolder-node/src/alpha.ts index 1bb013832c..6a0e34faf7 100644 --- a/plugins/scaffolder-node/src/alpha.ts +++ b/plugins/scaffolder-node/src/alpha.ts @@ -22,6 +22,8 @@ import { TaskBroker, } from '@backstage/plugin-scaffolder-node'; +export * from './tasks/alpha'; + /** * Extension point for managing scaffolder actions. * diff --git a/plugins/scaffolder-node/src/tasks/alpha.ts b/plugins/scaffolder-node/src/tasks/alpha.ts new file mode 100644 index 0000000000..fb6b09026c --- /dev/null +++ b/plugins/scaffolder-node/src/tasks/alpha.ts @@ -0,0 +1,16 @@ +/* + * Copyright 2024 The Backstage Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +export * from './serializer'; diff --git a/plugins/scaffolder-node/src/tasks/index.ts b/plugins/scaffolder-node/src/tasks/index.ts index b1754a1f78..930de95237 100644 --- a/plugins/scaffolder-node/src/tasks/index.ts +++ b/plugins/scaffolder-node/src/tasks/index.ts @@ -26,5 +26,3 @@ export type { TaskEventType, TaskStatus, } from './types'; - -export * from './serializer';