paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 28 Packages Projects Releases Wiki Activity

scaffolder-{backend,node}: update API reports + fixes

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-08-15 16:39:13 +02:00
parent 349611126a
commit 6565eeb2d4
4 changed files with 164 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder-backend/alpha-api-report.md
+1 -16
View File
@@ -12,11 +12,7 @@ import { PermissionCriteria } from '@backstage/plugin-permission-common';
import { PermissionRule } from '@backstage/plugin-permission-node';
import { PermissionRuleParams } from '@backstage/plugin-permission-common';
import { ResourcePermission } from '@backstage/plugin-permission-common';
import { TaskBroker } from '@backstage/plugin-scaffolder-backend';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { TemplateEntityStepV1beta3 } from '@backstage/plugin-scaffolder-common';
import { TemplateFilter } from '@backstage/plugin-scaffolder-backend';
import { TemplateGlobal } from '@backstage/plugin-scaffolder-backend';
import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
// @alpha
@@ -90,18 +86,7 @@ export const scaffolderActionConditions: Conditions<{
}>;
// @alpha
export const scaffolderPlugin: (
options?: ScaffolderPluginOptions | undefined,
) => BackendFeature;
// @alpha
export type ScaffolderPluginOptions = {
actions?: TemplateAction<any, any>[];
taskWorkers?: number;
taskBroker?: TaskBroker;
additionalTemplateFilters?: Record<string, TemplateFilter>;
additionalTemplateGlobals?: Record<string, TemplateGlobal>;
};
export const scaffolderPlugin: () => BackendFeature;
// @alpha
export const scaffolderTemplateConditions: Conditions<{
plugins/scaffolder-backend/api-report.md
+33 -91
View File
@@ -19,11 +19,9 @@ import { GithubCredentialsProvider } from '@backstage/integration';
import { HumanDuration } from '@backstage/types';
import { IdentityApi } from '@backstage/plugin-auth-node';
import { JsonObject } from '@backstage/types';
import { JsonValue } from '@backstage/types';
import { Knex } from 'knex';
import { LocationSpec } from '@backstage/plugin-catalog-common';
import { Logger } from 'winston';
import { Observable } from '@backstage/types';
import { Octokit } from 'octokit';
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
import { PermissionRule } from '@backstage/plugin-permission-node';
@@ -35,12 +33,23 @@ import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-
import { Schema } from 'jsonschema';
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';
import { TaskBroker as TaskBroker_2 } from '@backstage/plugin-scaffolder-node';
import { TaskBrokerDispatchOptions as TaskBrokerDispatchOptions_2 } from '@backstage/plugin-scaffolder-node';
import { TaskBrokerDispatchResult as TaskBrokerDispatchResult_2 } from '@backstage/plugin-scaffolder-node';
import { TaskCompletionState as TaskCompletionState_2 } from '@backstage/plugin-scaffolder-node';
import { TaskContext as TaskContext_2 } from '@backstage/plugin-scaffolder-node';
import { TaskEventType as TaskEventType_2 } from '@backstage/plugin-scaffolder-node';
import { TaskSecrets as TaskSecrets_2 } 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 { TemplateActionOptions } 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';
import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
import { UrlReader } from '@backstage/backend-common';
import { ZodType } from 'zod';
@@ -886,89 +895,29 @@ export class ScaffolderEntitiesProcessor implements CatalogProcessor {
validateEntityKind(entity: Entity): Promise<boolean>;
}
// @public
export type SerializedTask = {
id: string;
spec: TaskSpec;
status: TaskStatus;
createdAt: string;
lastHeartbeatAt?: string;
createdBy?: string;
secrets?: TaskSecrets_2;
};
// @public @deprecated
export type SerializedTask = SerializedTask_2;
// @public
export type SerializedTaskEvent = {
id: number;
taskId: string;
body: JsonObject;
type: TaskEventType;
createdAt: string;
};
// @public @deprecated
export type SerializedTaskEvent = SerializedTaskEvent_2;
// @public
export interface TaskBroker {
// (undocumented)
cancel?(taskId: string): Promise<void>;
// (undocumented)
claim(): Promise<TaskContext>;
// (undocumented)
dispatch(
options: TaskBrokerDispatchOptions,
): Promise<TaskBrokerDispatchResult>;
// (undocumented)
event$(options: { taskId: string; after: number | undefined }): Observable<{
events: SerializedTaskEvent[];
}>;
// (undocumented)
get(taskId: string): Promise<SerializedTask>;
// (undocumented)
list?(options?: { createdBy?: string }): Promise<{
tasks: SerializedTask[];
}>;
// (undocumented)
vacuumTasks(options: { timeoutS: number }): Promise<void>;
}
// @public @deprecated
export type TaskBroker = TaskBroker_2;
// @public
export type TaskBrokerDispatchOptions = {
spec: TaskSpec;
secrets?: TaskSecrets_2;
createdBy?: string;
};
// @public @deprecated
export type TaskBrokerDispatchOptions = TaskBrokerDispatchOptions_2;
// @public
export type TaskBrokerDispatchResult = {
taskId: string;
};
// @public @deprecated
export type TaskBrokerDispatchResult = TaskBrokerDispatchResult_2;
// @public
export type TaskCompletionState = 'failed' | 'completed';
// @public @deprecated
export type TaskCompletionState = TaskCompletionState_2;
// @public
export interface TaskContext {
// (undocumented)
cancelSignal: AbortSignal;
// (undocumented)
complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
// (undocumented)
createdBy?: string;
// (undocumented)
done: boolean;
// (undocumented)
emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
// (undocumented)
getWorkspaceName(): Promise<string>;
// (undocumented)
isDryRun?: boolean;
// (undocumented)
secrets?: TaskSecrets_2;
// (undocumented)
spec: TaskSpec;
}
// @public @deprecated
export type TaskContext = TaskContext_2;
// @public
export type TaskEventType = 'completion' | 'log' | 'cancelled';
// @public @deprecated
export type TaskEventType = TaskEventType_2;
// @public
export class TaskManager implements TaskContext {
@@ -1000,13 +949,8 @@ export class TaskManager implements TaskContext {
// @public @deprecated (undocumented)
export type TaskSecrets = TaskSecrets_2;
// @public
export type TaskStatus =
| 'cancelled'
| 'completed'
| 'failed'
| 'open'
| 'processing';
// @public @deprecated
export type TaskStatus = TaskStatus_2;
// @public
export interface TaskStore {
@@ -1103,13 +1047,11 @@ export class TemplateActionRegistry {
register(action: TemplateAction_2): void;
}
// @public (undocumented)
export type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
// @public @deprecated (undocumented)
export type TemplateFilter = TemplateFilter_2;
// @public (undocumented)
export type TemplateGlobal =
| ((...args: JsonValue[]) => JsonValue | undefined)
| JsonValue;
// @public @deprecated (undocumented)
export type TemplateGlobal = TemplateGlobal_2;
// @public (undocumented)
export type TemplatePermissionRuleInput<
plugins/scaffolder-backend/src/scaffolder/tasks/types.ts
+2 -2
View File
@@ -71,7 +71,7 @@ export type TaskEventType = _TaskEventType;
export type SerializedTaskEvent = _SerializedTaskEvent;
/**
* The result of {@link TaskBroker.dispatch}
* The result of `TaskBroker.dispatch`.
*
* @public
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
@@ -79,7 +79,7 @@ export type SerializedTaskEvent = _SerializedTaskEvent;
export type TaskBrokerDispatchResult = _TaskBrokerDispatchResult;
/**
* The options passed to {@link TaskBroker.dispatch}
* The options passed to `TaskBroker.dispatch`.
* Currently a spec and optional secrets
*
* @public