breaking: removing the deprecated files in scaffolder backend
Signed-off-by: benjdlambert <ben@blam.sh>
This commit is contained in:
@@ -0,0 +1,25 @@
|
||||
---
|
||||
'@backstage/plugin-scaffolder-backend': major
|
||||
---
|
||||
|
||||
Removal of deprecated re-exports from module packages.
|
||||
|
||||
The following functions have been re-exported from the `scaffolder-backend` plugin for quite some time, and now it's time to clean them up. They've been moved as follows:
|
||||
|
||||
- `createPublishAzureAction` should be imported from `@backstage/plugin-scaffolder-backend-module-azure` instead.
|
||||
|
||||
- `createPublishBitbucketCloudAction` should be imported from `@backstage/plugin-scaffolder-backend-module-bitbucket-cloud` instead.
|
||||
|
||||
- `createPublishBitbucketServerAction` and `createPublishBitbucketServerPullRequestAction` can be imported from `@backstage/plugin-scaffolder-backend-module-bitbucket-server` instead.
|
||||
|
||||
- `createPublishBitbucketAction` should be imported from `@backstage/plugin-scaffolder-backend-module-bitbucket` instead.
|
||||
|
||||
- `createPublishGerritAction` and `createPublishGerritReviewAction` can be imported from `@backstage/plugin-scaffolder-backend-module-gerrit` instead.
|
||||
|
||||
- `createGithubActionsDispatchAction`, `createGithubDeployKeyAction`, `createGithubEnvironmentAction`, `createGithubIssuesLabelAction`, `CreateGithubPullRequestActionOptions`, `createGithubRepoCreateAction`, `createGithubRepoPushAction`, `createGithubWebhookAction`, and `createPublishGithubAction` can be imported from `@backstage/plugin-scaffolder-backend-module-github` instead.
|
||||
|
||||
- `createPublishGitlabAction` should be imported from `@backstage/plugin-scaffolder-backend-module-gitlab` instead.
|
||||
|
||||
- `ActionContext`. `createTemplateAction`, `executeShellCommand`, `ExecuteShellCommandOptions`, `fetchContents`, `TaskSecrets`, and `TemplateAction` should be imported from `@backstage/plugin-scaffolder-node` instead.
|
||||
|
||||
- `ScaffolderEntitiesProcessor` should be imported from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model` instead.
|
||||
@@ -3,7 +3,6 @@
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
import { ActionContext as ActionContext_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { AuditorService } from '@backstage/backend-plugin-api';
|
||||
import { AuthService } from '@backstage/backend-plugin-api';
|
||||
import { AutocompleteHandler } from '@backstage/plugin-scaffolder-node/alpha';
|
||||
@@ -13,32 +12,11 @@ import { CatalogApi } from '@backstage/catalog-client';
|
||||
import { Config } from '@backstage/config';
|
||||
import { CreatedTemplateFilter } from '@backstage/plugin-scaffolder-node/alpha';
|
||||
import { CreatedTemplateGlobal } from '@backstage/plugin-scaffolder-node/alpha';
|
||||
import { createGithubActionsDispatchAction as createGithubActionsDispatchAction_2 } from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
import { createGithubDeployKeyAction as createGithubDeployKeyAction_2 } from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
import { createGithubEnvironmentAction as createGithubEnvironmentAction_2 } from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
import { createGithubIssuesLabelAction as createGithubIssuesLabelAction_2 } from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
import { CreateGithubPullRequestActionOptions as CreateGithubPullRequestActionOptions_2 } from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
import { createGithubRepoCreateAction as createGithubRepoCreateAction_2 } from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
import { createGithubRepoPushAction as createGithubRepoPushAction_2 } from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
import { createGithubWebhookAction as createGithubWebhookAction_2 } from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
import { createPublishAzureAction as createPublishAzureAction_2 } from '@backstage/plugin-scaffolder-backend-module-azure';
|
||||
import { createPublishBitbucketAction as createPublishBitbucketAction_2 } from '@backstage/plugin-scaffolder-backend-module-bitbucket';
|
||||
import { createPublishBitbucketCloudAction as createPublishBitbucketCloudAction_2 } from '@backstage/plugin-scaffolder-backend-module-bitbucket-cloud';
|
||||
import { createPublishBitbucketServerAction as createPublishBitbucketServerAction_2 } from '@backstage/plugin-scaffolder-backend-module-bitbucket-server';
|
||||
import { createPublishBitbucketServerPullRequestAction as createPublishBitbucketServerPullRequestAction_2 } from '@backstage/plugin-scaffolder-backend-module-bitbucket-server';
|
||||
import { createPublishGerritAction as createPublishGerritAction_2 } from '@backstage/plugin-scaffolder-backend-module-gerrit';
|
||||
import { createPublishGerritReviewAction as createPublishGerritReviewAction_2 } from '@backstage/plugin-scaffolder-backend-module-gerrit';
|
||||
import { createPublishGithubAction as createPublishGithubAction_2 } from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
import { createPublishGitlabAction as createPublishGitlabAction_2 } from '@backstage/plugin-scaffolder-backend-module-gitlab';
|
||||
import { createTemplateAction as createTemplateAction_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { DatabaseService } from '@backstage/backend-plugin-api';
|
||||
import { DiscoveryService } from '@backstage/backend-plugin-api';
|
||||
import { Duration } from 'luxon';
|
||||
import { EventsService } from '@backstage/plugin-events-node';
|
||||
import { executeShellCommand as executeShellCommand_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { ExecuteShellCommandOptions } from '@backstage/plugin-scaffolder-node';
|
||||
import express from 'express';
|
||||
import { fetchContents as fetchContents_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { HttpAuthService } from '@backstage/backend-plugin-api';
|
||||
import { HumanDuration } from '@backstage/types';
|
||||
import { IdentityApi } from '@backstage/plugin-auth-node';
|
||||
@@ -53,9 +31,7 @@ import { PermissionRuleParams } from '@backstage/plugin-permission-common';
|
||||
import { PermissionsService } from '@backstage/backend-plugin-api';
|
||||
import { RESOURCE_TYPE_SCAFFOLDER_ACTION } from '@backstage/plugin-scaffolder-common/alpha';
|
||||
import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common/alpha';
|
||||
import { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessor_2 } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';
|
||||
import { SchedulerService } from '@backstage/backend-plugin-api';
|
||||
import { ScmIntegrationRegistry } from '@backstage/integration';
|
||||
import { ScmIntegrations } from '@backstage/integration';
|
||||
import { SerializedTask as SerializedTask_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { SerializedTaskEvent as SerializedTaskEvent_2 } from '@backstage/plugin-scaffolder-node';
|
||||
@@ -66,11 +42,11 @@ import { TaskCompletionState as TaskCompletionState_2 } from '@backstage/plugin-
|
||||
import { TaskContext as TaskContext_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { TaskEventType as TaskEventType_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { TaskRecovery } from '@backstage/plugin-scaffolder-common';
|
||||
import { TaskSecrets as TaskSecrets_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { TaskSecrets } from '@backstage/plugin-scaffolder-node';
|
||||
import { TaskSpec } from '@backstage/plugin-scaffolder-common';
|
||||
import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common';
|
||||
import { TaskStatus as TaskStatus_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { TemplateAction as TemplateAction_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
|
||||
import { TemplateEntityStepV1beta3 } from '@backstage/plugin-scaffolder-common';
|
||||
import { TemplateFilter as TemplateFilter_2 } from '@backstage/plugin-scaffolder-node';
|
||||
import { TemplateGlobal as TemplateGlobal_2 } from '@backstage/plugin-scaffolder-node';
|
||||
@@ -78,9 +54,6 @@ import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
|
||||
import { UrlReaderService } from '@backstage/backend-plugin-api';
|
||||
import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export type ActionContext<TInput extends JsonObject> = ActionContext_2<TInput>;
|
||||
|
||||
// @public (undocumented)
|
||||
export type ActionPermissionRuleInput<
|
||||
TParams extends PermissionRuleParams = PermissionRuleParams,
|
||||
@@ -94,7 +67,7 @@ export type ActionPermissionRuleInput<
|
||||
// @public
|
||||
export const createBuiltinActions: (
|
||||
options: CreateBuiltInActionsOptions,
|
||||
) => TemplateAction_2[];
|
||||
) => TemplateAction[];
|
||||
|
||||
// @public
|
||||
export interface CreateBuiltInActionsOptions {
|
||||
@@ -113,7 +86,7 @@ export function createCatalogRegisterAction(options: {
|
||||
catalogClient: CatalogApi;
|
||||
integrations: ScmIntegrations;
|
||||
auth?: AuthService;
|
||||
}): TemplateAction_2<
|
||||
}): TemplateAction<
|
||||
| {
|
||||
catalogInfoUrl: string;
|
||||
optional?: boolean;
|
||||
@@ -128,7 +101,7 @@ export function createCatalogRegisterAction(options: {
|
||||
>;
|
||||
|
||||
// @public
|
||||
export function createCatalogWriteAction(): TemplateAction_2<
|
||||
export function createCatalogWriteAction(): TemplateAction<
|
||||
{
|
||||
entity: Record<string, any>;
|
||||
filePath?: string | undefined;
|
||||
@@ -138,13 +111,13 @@ export function createCatalogWriteAction(): TemplateAction_2<
|
||||
>;
|
||||
|
||||
// @public
|
||||
export function createDebugLogAction(): TemplateAction_2<any, any, 'v1'>;
|
||||
export function createDebugLogAction(): TemplateAction<any, any, 'v1'>;
|
||||
|
||||
// @public
|
||||
export function createFetchCatalogEntityAction(options: {
|
||||
catalogClient: CatalogApi;
|
||||
auth?: AuthService;
|
||||
}): TemplateAction_2<
|
||||
}): TemplateAction<
|
||||
{
|
||||
entityRef?: string | undefined;
|
||||
entityRefs?: string[] | undefined;
|
||||
@@ -163,7 +136,7 @@ export function createFetchCatalogEntityAction(options: {
|
||||
export function createFetchPlainAction(options: {
|
||||
reader: UrlReaderService;
|
||||
integrations: ScmIntegrations;
|
||||
}): TemplateAction_2<
|
||||
}): TemplateAction<
|
||||
{
|
||||
url: string;
|
||||
targetPath?: string;
|
||||
@@ -177,7 +150,7 @@ export function createFetchPlainAction(options: {
|
||||
export function createFetchPlainFileAction(options: {
|
||||
reader: UrlReaderService;
|
||||
integrations: ScmIntegrations;
|
||||
}): TemplateAction_2<
|
||||
}): TemplateAction<
|
||||
{
|
||||
url: string;
|
||||
targetPath: string;
|
||||
@@ -193,7 +166,7 @@ export function createFetchTemplateAction(options: {
|
||||
integrations: ScmIntegrations;
|
||||
additionalTemplateFilters?: Record<string, TemplateFilter_2>;
|
||||
additionalTemplateGlobals?: Record<string, TemplateGlobal_2>;
|
||||
}): TemplateAction_2<
|
||||
}): TemplateAction<
|
||||
{
|
||||
url: string;
|
||||
targetPath?: string;
|
||||
@@ -217,7 +190,7 @@ export function createFetchTemplateFileAction(options: {
|
||||
integrations: ScmIntegrations;
|
||||
additionalTemplateFilters?: Record<string, TemplateFilter_2>;
|
||||
additionalTemplateGlobals?: Record<string, TemplateGlobal_2>;
|
||||
}): TemplateAction_2<
|
||||
}): TemplateAction<
|
||||
{
|
||||
url: string;
|
||||
targetPath: string;
|
||||
@@ -233,7 +206,7 @@ export function createFetchTemplateFileAction(options: {
|
||||
>;
|
||||
|
||||
// @public
|
||||
export const createFilesystemDeleteAction: () => TemplateAction_2<
|
||||
export const createFilesystemDeleteAction: () => TemplateAction<
|
||||
{
|
||||
files: string[];
|
||||
},
|
||||
@@ -242,7 +215,7 @@ export const createFilesystemDeleteAction: () => TemplateAction_2<
|
||||
>;
|
||||
|
||||
// @public
|
||||
export const createFilesystemReadDirAction: () => TemplateAction_2<
|
||||
export const createFilesystemReadDirAction: () => TemplateAction<
|
||||
{
|
||||
recursive: boolean;
|
||||
paths: string[];
|
||||
@@ -263,7 +236,7 @@ export const createFilesystemReadDirAction: () => TemplateAction_2<
|
||||
>;
|
||||
|
||||
// @public
|
||||
export const createFilesystemRenameAction: () => TemplateAction_2<
|
||||
export const createFilesystemRenameAction: () => TemplateAction<
|
||||
{
|
||||
files: Array<{
|
||||
from: string;
|
||||
@@ -275,127 +248,13 @@ export const createFilesystemRenameAction: () => TemplateAction_2<
|
||||
'v1'
|
||||
>;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createGithubActionsDispatchAction: typeof createGithubActionsDispatchAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createGithubDeployKeyAction: typeof createGithubDeployKeyAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createGithubEnvironmentAction: typeof createGithubEnvironmentAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createGithubIssuesLabelAction: typeof createGithubIssuesLabelAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export type CreateGithubPullRequestActionOptions =
|
||||
CreateGithubPullRequestActionOptions_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createGithubRepoCreateAction: typeof createGithubRepoCreateAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createGithubRepoPushAction: typeof createGithubRepoPushAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createGithubWebhookAction: typeof createGithubWebhookAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishAzureAction: typeof createPublishAzureAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishBitbucketAction: typeof createPublishBitbucketAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishBitbucketCloudAction: typeof createPublishBitbucketCloudAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishBitbucketServerAction: typeof createPublishBitbucketServerAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishBitbucketServerPullRequestAction: typeof createPublishBitbucketServerPullRequestAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishGerritAction: typeof createPublishGerritAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishGerritReviewAction: typeof createPublishGerritReviewAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishGithubAction: typeof createPublishGithubAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishGithubPullRequestAction: (
|
||||
options: CreateGithubPullRequestActionOptions_2,
|
||||
) => TemplateAction_2<
|
||||
{
|
||||
title: string;
|
||||
branchName: string;
|
||||
targetBranchName?: string;
|
||||
description: string;
|
||||
repoUrl: string;
|
||||
draft?: boolean;
|
||||
targetPath?: string;
|
||||
sourcePath?: string;
|
||||
token?: string;
|
||||
reviewers?: string[];
|
||||
assignees?: string[];
|
||||
teamReviewers?: string[];
|
||||
commitMessage?: string;
|
||||
update?: boolean;
|
||||
forceFork?: boolean;
|
||||
gitAuthorName?: string;
|
||||
gitAuthorEmail?: string;
|
||||
forceEmptyGitAuthor?: boolean;
|
||||
createWhenEmpty?: boolean;
|
||||
},
|
||||
JsonObject,
|
||||
'v1'
|
||||
>;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishGitlabAction: typeof createPublishGitlabAction_2;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createPublishGitlabMergeRequestAction: (options: {
|
||||
integrations: ScmIntegrationRegistry;
|
||||
}) => TemplateAction_2<
|
||||
{
|
||||
repoUrl: string;
|
||||
title: string;
|
||||
description: string;
|
||||
branchName: string;
|
||||
targetBranchName?: string | undefined;
|
||||
sourcePath?: string | undefined;
|
||||
targetPath?: string | undefined;
|
||||
token?: string | undefined;
|
||||
commitAction?: 'auto' | 'update' | 'delete' | 'create' | 'skip' | undefined;
|
||||
projectid?: string | undefined;
|
||||
removeSourceBranch?: boolean | undefined;
|
||||
assignee?: string | undefined;
|
||||
reviewers?: string[] | undefined;
|
||||
assignReviewersFromApprovalRules?: boolean | undefined;
|
||||
labels?: string | string[] | undefined;
|
||||
},
|
||||
{
|
||||
targetBranchName: string;
|
||||
projectid: string;
|
||||
projectPath: string;
|
||||
mergeRequestUrl: string;
|
||||
},
|
||||
'v2'
|
||||
>;
|
||||
|
||||
// @public @deprecated
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export const createTemplateAction: typeof createTemplateAction_2;
|
||||
|
||||
// @public
|
||||
export function createWaitAction(options?: {
|
||||
maxWaitTime?: Duration | HumanDuration;
|
||||
}): TemplateAction_2<HumanDuration, JsonObject, 'v1'>;
|
||||
}): TemplateAction<HumanDuration, JsonObject, 'v1'>;
|
||||
|
||||
// @public
|
||||
export type CreateWorkerOptions = {
|
||||
@@ -415,7 +274,7 @@ export type CreateWorkerOptions = {
|
||||
// @public
|
||||
export interface CurrentClaimedTask {
|
||||
createdBy?: string;
|
||||
secrets?: TaskSecrets_2;
|
||||
secrets?: TaskSecrets;
|
||||
spec: TaskSpec;
|
||||
state?: JsonObject;
|
||||
taskId: string;
|
||||
@@ -508,10 +367,7 @@ export class DatabaseTaskStore implements TaskStore {
|
||||
targetPath: string;
|
||||
}): Promise<void>;
|
||||
// (undocumented)
|
||||
retryTask?(options: {
|
||||
secrets?: TaskSecrets_2;
|
||||
taskId: string;
|
||||
}): Promise<void>;
|
||||
retryTask?(options: { secrets?: TaskSecrets; taskId: string }): Promise<void>;
|
||||
// (undocumented)
|
||||
saveTaskState(options: { taskId: string; state?: JsonObject }): Promise<void>;
|
||||
// (undocumented)
|
||||
@@ -526,16 +382,10 @@ export type DatabaseTaskStoreOptions = {
|
||||
events?: EventsService;
|
||||
};
|
||||
|
||||
// @public @deprecated
|
||||
export const executeShellCommand: typeof executeShellCommand_2;
|
||||
|
||||
// @public @deprecated
|
||||
export const fetchContents: typeof fetchContents_2;
|
||||
|
||||
// @public @deprecated
|
||||
export interface RouterOptions {
|
||||
// (undocumented)
|
||||
actions?: TemplateAction_2<any, any, any>[];
|
||||
actions?: TemplateAction<any, any, any>[];
|
||||
// (undocumented)
|
||||
additionalTemplateFilters?:
|
||||
| Record<string, TemplateFilter_2>
|
||||
@@ -587,12 +437,6 @@ export interface RouterOptions {
|
||||
taskWorkers?: number;
|
||||
}
|
||||
|
||||
// @public @deprecated
|
||||
export type RunCommandOptions = ExecuteShellCommandOptions;
|
||||
|
||||
// @public @deprecated
|
||||
export const ScaffolderEntitiesProcessor: typeof ScaffolderEntitiesProcessor_2;
|
||||
|
||||
// @public
|
||||
const scaffolderPlugin: BackendFeature;
|
||||
export default scaffolderPlugin;
|
||||
@@ -662,7 +506,7 @@ export class TaskManager implements TaskContext_2 {
|
||||
targetPath: string;
|
||||
}): Promise<void>;
|
||||
// (undocumented)
|
||||
get secrets(): TaskSecrets_2 | undefined;
|
||||
get secrets(): TaskSecrets | undefined;
|
||||
// (undocumented)
|
||||
serializeWorkspace?(options: { path: string }): Promise<void>;
|
||||
// (undocumented)
|
||||
@@ -683,9 +527,6 @@ export class TaskManager implements TaskContext_2 {
|
||||
): Promise<void>;
|
||||
}
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export type TaskSecrets = TaskSecrets_2;
|
||||
|
||||
// @public @deprecated
|
||||
export type TaskStatus = TaskStatus_2;
|
||||
|
||||
@@ -778,10 +619,7 @@ export interface TaskStore {
|
||||
targetPath: string;
|
||||
}): Promise<void>;
|
||||
// (undocumented)
|
||||
retryTask?(options: {
|
||||
secrets?: TaskSecrets_2;
|
||||
taskId: string;
|
||||
}): Promise<void>;
|
||||
retryTask?(options: { secrets?: TaskSecrets; taskId: string }): Promise<void>;
|
||||
// (undocumented)
|
||||
saveTaskState?(options: {
|
||||
taskId: string;
|
||||
@@ -803,7 +641,7 @@ export interface TaskStore {
|
||||
export type TaskStoreCreateTaskOptions = {
|
||||
spec: TaskSpec;
|
||||
createdBy?: string;
|
||||
secrets?: TaskSecrets_2;
|
||||
secrets?: TaskSecrets;
|
||||
};
|
||||
|
||||
// @public
|
||||
@@ -850,18 +688,14 @@ export class TaskWorker {
|
||||
stop(): Promise<void>;
|
||||
}
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
export type TemplateAction<TInput extends JsonObject> =
|
||||
TemplateAction_2<TInput>;
|
||||
|
||||
// @public
|
||||
export class TemplateActionRegistry {
|
||||
// (undocumented)
|
||||
get(actionId: string): TemplateAction_2<any, any, any>;
|
||||
get(actionId: string): TemplateAction<any, any, any>;
|
||||
// (undocumented)
|
||||
list(): TemplateAction_2<any, any, any>[];
|
||||
list(): TemplateAction<any, any, any>[];
|
||||
// (undocumented)
|
||||
register(action: TemplateAction_2<any, any, any>): void;
|
||||
register(action: TemplateAction<any, any, any>): void;
|
||||
}
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
|
||||
@@ -1,86 +0,0 @@
|
||||
/*
|
||||
* Copyright 2023 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.
|
||||
*/
|
||||
|
||||
import {
|
||||
ActionContext as ActionContextNode,
|
||||
createTemplateAction as createTemplateActionNode,
|
||||
TaskSecrets as TaskSecretsNode,
|
||||
TemplateAction as TemplateActionNode,
|
||||
executeShellCommand as executeShellCommandNode,
|
||||
ExecuteShellCommandOptions as ExecuteShellCommandOptionsNode,
|
||||
fetchContents as fetchContentsNode,
|
||||
} from '@backstage/plugin-scaffolder-node';
|
||||
import { JsonObject } from '@backstage/types';
|
||||
import { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessorModule } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated Import from {@link @backstage/plugin-scaffolder-node#ActionContext} instead
|
||||
*/
|
||||
export type ActionContext<TInput extends JsonObject> =
|
||||
ActionContextNode<TInput>;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated Use `createTemplateAction` from `@backstage/plugin-scaffolder-node` instead
|
||||
*/
|
||||
export const createTemplateAction = createTemplateActionNode;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated Use `TaskSecrets` from `@backstage/plugin-scaffolder-node` instead
|
||||
*/
|
||||
export type TaskSecrets = TaskSecretsNode;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated Use `TemplateAction` from `@backstage/plugin-scaffolder-node` instead
|
||||
*/
|
||||
export type TemplateAction<TInput extends JsonObject> =
|
||||
TemplateActionNode<TInput>;
|
||||
|
||||
/**
|
||||
* Options for {@link executeShellCommand}.
|
||||
*
|
||||
* @public
|
||||
* @deprecated Use `ExecuteShellCommandOptions` from `@backstage/plugin-scaffolder-node` instead
|
||||
*/
|
||||
export type RunCommandOptions = ExecuteShellCommandOptionsNode;
|
||||
|
||||
/**
|
||||
* Run a command in a sub-process, normally a shell command.
|
||||
*
|
||||
* @public
|
||||
* @deprecated Use `executeShellCommand` from `@backstage/plugin-scaffolder-node` instead
|
||||
*/
|
||||
export const executeShellCommand = executeShellCommandNode;
|
||||
|
||||
/**
|
||||
* A helper function that reads the contents of a directory from the given URL.
|
||||
* Can be used in your own actions, and also used behind fetch:template and fetch:plain
|
||||
*
|
||||
* @public
|
||||
* @deprecated Use `fetchContents` from `@backstage/plugin-scaffolder-node` instead
|
||||
*/
|
||||
export const fetchContents = fetchContentsNode;
|
||||
|
||||
/**
|
||||
* Adds support for scaffolder specific entity kinds to the catalog.
|
||||
*
|
||||
* @public
|
||||
* @deprecated Import from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model` instead
|
||||
*/
|
||||
export const ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessorModule;
|
||||
@@ -24,5 +24,3 @@ export { scaffolderPlugin as default } from './ScaffolderPlugin';
|
||||
export * from './scaffolder';
|
||||
export * from './service/router';
|
||||
export * from './lib';
|
||||
|
||||
export * from './deprecated';
|
||||
|
||||
@@ -1,163 +0,0 @@
|
||||
/*
|
||||
* Copyright 2023 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.
|
||||
*/
|
||||
import {
|
||||
createGithubActionsDispatchAction as githubActionsDispatch,
|
||||
createGithubDeployKeyAction as githubDeployKey,
|
||||
createGithubEnvironmentAction as githubEnvironment,
|
||||
createGithubIssuesLabelAction as githubIssuesLabel,
|
||||
CreateGithubPullRequestActionOptions as GithubPullRequestActionOptions,
|
||||
createGithubRepoCreateAction as githubRepoCreate,
|
||||
createGithubRepoPushAction as githubRepoPush,
|
||||
createGithubWebhookAction as githubWebhook,
|
||||
createPublishGithubAction as publishGithub,
|
||||
createPublishGithubPullRequestAction as publishGithubPullRequest,
|
||||
} from '@backstage/plugin-scaffolder-backend-module-github';
|
||||
|
||||
import {
|
||||
createPublishGitlabAction as publishGitlab,
|
||||
createPublishGitlabMergeRequestAction as publishGitlabMergeRequest,
|
||||
} from '@backstage/plugin-scaffolder-backend-module-gitlab';
|
||||
|
||||
import { createPublishAzureAction as publishAzure } from '@backstage/plugin-scaffolder-backend-module-azure';
|
||||
|
||||
import { createPublishBitbucketAction as publishBitbucket } from '@backstage/plugin-scaffolder-backend-module-bitbucket';
|
||||
|
||||
import { createPublishBitbucketCloudAction as publishBitbucketCloud } from '@backstage/plugin-scaffolder-backend-module-bitbucket-cloud';
|
||||
|
||||
import {
|
||||
createPublishBitbucketServerAction as publishBitbucketServer,
|
||||
createPublishBitbucketServerPullRequestAction as publishBitbucketServerPullRequest,
|
||||
} from '@backstage/plugin-scaffolder-backend-module-bitbucket-server';
|
||||
|
||||
import {
|
||||
createPublishGerritAction as publishGerrit,
|
||||
createPublishGerritReviewAction as publishGerritReview,
|
||||
} from '@backstage/plugin-scaffolder-backend-module-gerrit';
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export const createGithubActionsDispatchAction = githubActionsDispatch;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export const createGithubDeployKeyAction = githubDeployKey;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export const createGithubEnvironmentAction = githubEnvironment;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export const createGithubIssuesLabelAction = githubIssuesLabel;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export type CreateGithubPullRequestActionOptions =
|
||||
GithubPullRequestActionOptions;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export const createGithubRepoCreateAction = githubRepoCreate;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export const createGithubRepoPushAction = githubRepoPush;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export const createGithubWebhookAction = githubWebhook;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export const createPublishGithubAction = publishGithub;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
||||
*/
|
||||
export const createPublishGithubPullRequestAction = publishGithubPullRequest;
|
||||
|
||||
/**
|
||||
* @public @deprecated use "createPublishBitbucketCloudAction" from \@backstage/plugin-scaffolder-backend-module-bitbucket-cloud or "createPublishBitbucketServerAction" from \@backstage/plugin-scaffolder-backend-module-bitbucket-server instead
|
||||
*/
|
||||
export const createPublishBitbucketAction = publishBitbucket;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-bitbucket-cloud` instead
|
||||
*/
|
||||
export const createPublishBitbucketCloudAction = publishBitbucketCloud;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-bitbucket-server` instead
|
||||
*/
|
||||
export const createPublishBitbucketServerAction = publishBitbucketServer;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-bitbucket-server` instead
|
||||
*/
|
||||
export const createPublishBitbucketServerPullRequestAction =
|
||||
publishBitbucketServerPullRequest;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-azure` instead
|
||||
*/
|
||||
export const createPublishAzureAction = publishAzure;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-gerrit` instead
|
||||
*/
|
||||
export const createPublishGerritAction = publishGerrit;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-gerrit` instead
|
||||
*/
|
||||
export const createPublishGerritReviewAction = publishGerritReview;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-gitlab` instead
|
||||
*/
|
||||
export const createPublishGitlabAction = publishGitlab;
|
||||
|
||||
/**
|
||||
* @public
|
||||
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-gitlab` instead
|
||||
*/
|
||||
export const createPublishGitlabMergeRequestAction = publishGitlabMergeRequest;
|
||||
@@ -15,6 +15,5 @@
|
||||
*/
|
||||
|
||||
export * from './builtin';
|
||||
export * from './deprecated';
|
||||
|
||||
export { TemplateActionRegistry } from './TemplateActionRegistry';
|
||||
|
||||
Reference in New Issue
Block a user