@backstage/plugin-scaffolder-backend 1.33.1-next.0 → 2.0.0-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +88 -0
- package/dist/ScaffolderPlugin.cjs.js +0 -3
- package/dist/ScaffolderPlugin.cjs.js.map +1 -1
- package/dist/alpha.cjs.js +5 -9
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/alpha.d.ts +1 -5
- package/dist/index.cjs.js +0 -26
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +45 -361
- package/dist/lib/templating/SecureTemplater.cjs.js.map +1 -1
- package/dist/scaffolder/actions/TemplateActionRegistry.cjs.js.map +1 -1
- package/dist/scaffolder/actions/builtin/fetch/template.cjs.js.map +1 -1
- package/dist/scaffolder/actions/builtin/fetch/templateActionHandler.cjs.js +4 -19
- package/dist/scaffolder/actions/builtin/fetch/templateActionHandler.cjs.js.map +1 -1
- package/dist/scaffolder/tasks/DatabaseTaskStore.cjs.js.map +1 -1
- package/dist/scaffolder/tasks/StorageTaskBroker.cjs.js.map +1 -1
- package/dist/scaffolder/tasks/TaskWorker.cjs.js.map +1 -1
- package/dist/service/{conditionExports.cjs.js → alpha.cjs.js} +1 -1
- package/dist/service/alpha.cjs.js.map +1 -0
- package/dist/service/permissions.cjs.js +14 -0
- package/dist/service/permissions.cjs.js.map +1 -0
- package/dist/service/router.cjs.js +30 -95
- package/dist/service/router.cjs.js.map +1 -1
- package/package.json +25 -27
- package/dist/deprecated.cjs.js +0 -15
- package/dist/deprecated.cjs.js.map +0 -1
- package/dist/scaffolder/actions/deprecated.cjs.js +0 -48
- package/dist/scaffolder/actions/deprecated.cjs.js.map +0 -1
- package/dist/service/conditionExports.cjs.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,33 +1,22 @@
|
|
|
1
1
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
2
|
-
import { AuthService, UrlReaderService, DatabaseService, BackstageCredentials, AuditorService
|
|
2
|
+
import { AuthService, UrlReaderService, DatabaseService, BackstageCredentials, AuditorService } from '@backstage/backend-plugin-api';
|
|
3
3
|
import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
|
|
4
|
-
import { TemplateFilter
|
|
4
|
+
import { TemplateFilter, TemplateGlobal, TemplateAction, TaskSecrets, SerializedTask, TaskStatus, SerializedTaskEvent, TaskContext, TaskCompletionState, TaskBroker } from '@backstage/plugin-scaffolder-node';
|
|
5
5
|
import * as _backstage_types from '@backstage/types';
|
|
6
6
|
import { HumanDuration, JsonObject, JsonValue } from '@backstage/types';
|
|
7
|
-
import * as _backstage_integration from '@backstage/integration';
|
|
8
7
|
import { ScmIntegrations } from '@backstage/integration';
|
|
9
8
|
import { CatalogApi } from '@backstage/catalog-client';
|
|
10
9
|
import { Config } from '@backstage/config';
|
|
11
10
|
import { Duration } from 'luxon';
|
|
12
|
-
import { createGithubActionsDispatchAction as createGithubActionsDispatchAction$1, createGithubDeployKeyAction as createGithubDeployKeyAction$1, createGithubEnvironmentAction as createGithubEnvironmentAction$1, createGithubIssuesLabelAction as createGithubIssuesLabelAction$1, CreateGithubPullRequestActionOptions as CreateGithubPullRequestActionOptions$1, createGithubRepoCreateAction as createGithubRepoCreateAction$1, createGithubRepoPushAction as createGithubRepoPushAction$1, createGithubWebhookAction as createGithubWebhookAction$1, createPublishGithubAction as createPublishGithubAction$1 } from '@backstage/plugin-scaffolder-backend-module-github';
|
|
13
|
-
import { createPublishGitlabAction as createPublishGitlabAction$1 } from '@backstage/plugin-scaffolder-backend-module-gitlab';
|
|
14
|
-
import { createPublishAzureAction as createPublishAzureAction$1 } from '@backstage/plugin-scaffolder-backend-module-azure';
|
|
15
|
-
import { createPublishBitbucketAction as createPublishBitbucketAction$1 } from '@backstage/plugin-scaffolder-backend-module-bitbucket';
|
|
16
|
-
import { createPublishBitbucketCloudAction as createPublishBitbucketCloudAction$1 } from '@backstage/plugin-scaffolder-backend-module-bitbucket-cloud';
|
|
17
|
-
import { createPublishBitbucketServerAction as createPublishBitbucketServerAction$1, createPublishBitbucketServerPullRequestAction as createPublishBitbucketServerPullRequestAction$1 } from '@backstage/plugin-scaffolder-backend-module-bitbucket-server';
|
|
18
|
-
import { createPublishGerritAction as createPublishGerritAction$1, createPublishGerritReviewAction as createPublishGerritReviewAction$1 } from '@backstage/plugin-scaffolder-backend-module-gerrit';
|
|
19
11
|
import { Knex } from 'knex';
|
|
20
12
|
import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
|
|
21
13
|
import { TaskSpec, TaskRecovery, TemplateEntityStepV1beta3, TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
|
|
22
14
|
import { EventsService } from '@backstage/plugin-events-node';
|
|
23
|
-
import { WorkspaceProvider
|
|
15
|
+
import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
|
|
24
16
|
import { Logger } from 'winston';
|
|
25
17
|
import { PermissionEvaluator, PermissionRuleParams } from '@backstage/plugin-permission-common';
|
|
26
|
-
import { IdentityApi } from '@backstage/plugin-auth-node';
|
|
27
18
|
import { PermissionRule } from '@backstage/plugin-permission-node';
|
|
28
19
|
import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE, RESOURCE_TYPE_SCAFFOLDER_ACTION } from '@backstage/plugin-scaffolder-common/alpha';
|
|
29
|
-
import express from 'express';
|
|
30
|
-
import { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessor$1 } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';
|
|
31
20
|
|
|
32
21
|
/**
|
|
33
22
|
* Scaffolder plugin
|
|
@@ -110,8 +99,8 @@ interface CreateBuiltInActionsOptions {
|
|
|
110
99
|
* Additional custom filters that will be passed to the nunjucks template engine for use in
|
|
111
100
|
* Template Manifests and also template skeleton files when using `fetch:template`.
|
|
112
101
|
*/
|
|
113
|
-
additionalTemplateFilters?: Record<string, TemplateFilter
|
|
114
|
-
additionalTemplateGlobals?: Record<string, TemplateGlobal
|
|
102
|
+
additionalTemplateFilters?: Record<string, TemplateFilter>;
|
|
103
|
+
additionalTemplateGlobals?: Record<string, TemplateGlobal>;
|
|
115
104
|
}
|
|
116
105
|
/**
|
|
117
106
|
* A function to generate create a list of default actions that the scaffolder provides.
|
|
@@ -123,7 +112,7 @@ interface CreateBuiltInActionsOptions {
|
|
|
123
112
|
* @returns A list of actions that can be used in the scaffolder
|
|
124
113
|
*
|
|
125
114
|
*/
|
|
126
|
-
declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => TemplateAction
|
|
115
|
+
declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => TemplateAction[];
|
|
127
116
|
|
|
128
117
|
/**
|
|
129
118
|
* Writes a message into the log or lists all files in the workspace
|
|
@@ -189,17 +178,13 @@ declare function createFetchPlainFileAction(options: {
|
|
|
189
178
|
declare function createFetchTemplateAction(options: {
|
|
190
179
|
reader: UrlReaderService;
|
|
191
180
|
integrations: ScmIntegrations;
|
|
192
|
-
additionalTemplateFilters?: Record<string, TemplateFilter
|
|
193
|
-
additionalTemplateGlobals?: Record<string, TemplateGlobal
|
|
181
|
+
additionalTemplateFilters?: Record<string, TemplateFilter>;
|
|
182
|
+
additionalTemplateGlobals?: Record<string, TemplateGlobal>;
|
|
194
183
|
}): _backstage_plugin_scaffolder_node.TemplateAction<{
|
|
195
184
|
url: string;
|
|
196
185
|
targetPath?: string;
|
|
197
186
|
values: any;
|
|
198
187
|
templateFileExtension?: string | boolean;
|
|
199
|
-
/**
|
|
200
|
-
* @deprecated This field is deprecated in favor of copyWithoutTemplating.
|
|
201
|
-
*/
|
|
202
|
-
copyWithoutRender?: string[];
|
|
203
188
|
copyWithoutTemplating?: string[];
|
|
204
189
|
cookiecutterCompat?: boolean;
|
|
205
190
|
replace?: boolean;
|
|
@@ -217,8 +202,8 @@ declare function createFetchTemplateAction(options: {
|
|
|
217
202
|
declare function createFetchTemplateFileAction(options: {
|
|
218
203
|
reader: UrlReaderService;
|
|
219
204
|
integrations: ScmIntegrations;
|
|
220
|
-
additionalTemplateFilters?: Record<string, TemplateFilter
|
|
221
|
-
additionalTemplateGlobals?: Record<string, TemplateGlobal
|
|
205
|
+
additionalTemplateFilters?: Record<string, TemplateFilter>;
|
|
206
|
+
additionalTemplateGlobals?: Record<string, TemplateGlobal>;
|
|
222
207
|
}): _backstage_plugin_scaffolder_node.TemplateAction<{
|
|
223
208
|
url: string;
|
|
224
209
|
targetPath: string;
|
|
@@ -270,223 +255,23 @@ declare const createFilesystemReadDirAction: () => _backstage_plugin_scaffolder_
|
|
|
270
255
|
}[];
|
|
271
256
|
}, "v1">;
|
|
272
257
|
|
|
273
|
-
/**
|
|
274
|
-
* @public
|
|
275
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
276
|
-
*/
|
|
277
|
-
declare const createGithubActionsDispatchAction: typeof createGithubActionsDispatchAction$1;
|
|
278
|
-
/**
|
|
279
|
-
* @public
|
|
280
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
281
|
-
*/
|
|
282
|
-
declare const createGithubDeployKeyAction: typeof createGithubDeployKeyAction$1;
|
|
283
|
-
/**
|
|
284
|
-
* @public
|
|
285
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
286
|
-
*/
|
|
287
|
-
declare const createGithubEnvironmentAction: typeof createGithubEnvironmentAction$1;
|
|
288
|
-
/**
|
|
289
|
-
* @public
|
|
290
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
291
|
-
*/
|
|
292
|
-
declare const createGithubIssuesLabelAction: typeof createGithubIssuesLabelAction$1;
|
|
293
|
-
/**
|
|
294
|
-
* @public
|
|
295
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
296
|
-
*/
|
|
297
|
-
type CreateGithubPullRequestActionOptions = CreateGithubPullRequestActionOptions$1;
|
|
298
|
-
/**
|
|
299
|
-
* @public
|
|
300
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
301
|
-
*/
|
|
302
|
-
declare const createGithubRepoCreateAction: typeof createGithubRepoCreateAction$1;
|
|
303
|
-
/**
|
|
304
|
-
* @public
|
|
305
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
306
|
-
*/
|
|
307
|
-
declare const createGithubRepoPushAction: typeof createGithubRepoPushAction$1;
|
|
308
|
-
/**
|
|
309
|
-
* @public
|
|
310
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
311
|
-
*/
|
|
312
|
-
declare const createGithubWebhookAction: typeof createGithubWebhookAction$1;
|
|
313
|
-
/**
|
|
314
|
-
* @public
|
|
315
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
316
|
-
*/
|
|
317
|
-
declare const createPublishGithubAction: typeof createPublishGithubAction$1;
|
|
318
|
-
/**
|
|
319
|
-
* @public
|
|
320
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-github` instead
|
|
321
|
-
*/
|
|
322
|
-
declare const createPublishGithubPullRequestAction: (options: CreateGithubPullRequestActionOptions$1) => _backstage_plugin_scaffolder_node.TemplateAction<{
|
|
323
|
-
title: string;
|
|
324
|
-
branchName: string;
|
|
325
|
-
targetBranchName?: string;
|
|
326
|
-
description: string;
|
|
327
|
-
repoUrl: string;
|
|
328
|
-
draft?: boolean;
|
|
329
|
-
targetPath?: string;
|
|
330
|
-
sourcePath?: string;
|
|
331
|
-
token?: string;
|
|
332
|
-
reviewers?: string[];
|
|
333
|
-
assignees?: string[];
|
|
334
|
-
teamReviewers?: string[];
|
|
335
|
-
commitMessage?: string;
|
|
336
|
-
update?: boolean;
|
|
337
|
-
forceFork?: boolean;
|
|
338
|
-
gitAuthorName?: string;
|
|
339
|
-
gitAuthorEmail?: string;
|
|
340
|
-
forceEmptyGitAuthor?: boolean;
|
|
341
|
-
createWhenEmpty?: boolean;
|
|
342
|
-
}, _backstage_types.JsonObject, "v1">;
|
|
343
|
-
/**
|
|
344
|
-
* @public @deprecated use "createPublishBitbucketCloudAction" from \@backstage/plugin-scaffolder-backend-module-bitbucket-cloud or "createPublishBitbucketServerAction" from \@backstage/plugin-scaffolder-backend-module-bitbucket-server instead
|
|
345
|
-
*/
|
|
346
|
-
declare const createPublishBitbucketAction: typeof createPublishBitbucketAction$1;
|
|
347
|
-
/**
|
|
348
|
-
* @public
|
|
349
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-bitbucket-cloud` instead
|
|
350
|
-
*/
|
|
351
|
-
declare const createPublishBitbucketCloudAction: typeof createPublishBitbucketCloudAction$1;
|
|
352
|
-
/**
|
|
353
|
-
* @public
|
|
354
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-bitbucket-server` instead
|
|
355
|
-
*/
|
|
356
|
-
declare const createPublishBitbucketServerAction: typeof createPublishBitbucketServerAction$1;
|
|
357
|
-
/**
|
|
358
|
-
* @public
|
|
359
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-bitbucket-server` instead
|
|
360
|
-
*/
|
|
361
|
-
declare const createPublishBitbucketServerPullRequestAction: typeof createPublishBitbucketServerPullRequestAction$1;
|
|
362
|
-
/**
|
|
363
|
-
* @public
|
|
364
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-azure` instead
|
|
365
|
-
*/
|
|
366
|
-
declare const createPublishAzureAction: typeof createPublishAzureAction$1;
|
|
367
|
-
/**
|
|
368
|
-
* @public
|
|
369
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-gerrit` instead
|
|
370
|
-
*/
|
|
371
|
-
declare const createPublishGerritAction: typeof createPublishGerritAction$1;
|
|
372
|
-
/**
|
|
373
|
-
* @public
|
|
374
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-gerrit` instead
|
|
375
|
-
*/
|
|
376
|
-
declare const createPublishGerritReviewAction: typeof createPublishGerritReviewAction$1;
|
|
377
|
-
/**
|
|
378
|
-
* @public
|
|
379
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-gitlab` instead
|
|
380
|
-
*/
|
|
381
|
-
declare const createPublishGitlabAction: typeof createPublishGitlabAction$1;
|
|
382
|
-
/**
|
|
383
|
-
* @public
|
|
384
|
-
* @deprecated use import from `@backstage/plugin-scaffolder-backend-module-gitlab` instead
|
|
385
|
-
*/
|
|
386
|
-
declare const createPublishGitlabMergeRequestAction: (options: {
|
|
387
|
-
integrations: _backstage_integration.ScmIntegrationRegistry;
|
|
388
|
-
}) => _backstage_plugin_scaffolder_node.TemplateAction<{
|
|
389
|
-
repoUrl: string;
|
|
390
|
-
title: string;
|
|
391
|
-
description: string;
|
|
392
|
-
branchName: string;
|
|
393
|
-
targetBranchName?: string | undefined;
|
|
394
|
-
sourcePath?: string | undefined;
|
|
395
|
-
targetPath?: string | undefined;
|
|
396
|
-
token?: string | undefined;
|
|
397
|
-
commitAction?: "auto" | "update" | "delete" | "create" | "skip" | undefined;
|
|
398
|
-
projectid?: string | undefined;
|
|
399
|
-
removeSourceBranch?: boolean | undefined;
|
|
400
|
-
assignee?: string | undefined;
|
|
401
|
-
reviewers?: string[] | undefined;
|
|
402
|
-
assignReviewersFromApprovalRules?: boolean | undefined;
|
|
403
|
-
labels?: string | string[] | undefined;
|
|
404
|
-
}, {
|
|
405
|
-
targetBranchName: string;
|
|
406
|
-
projectid: string;
|
|
407
|
-
projectPath: string;
|
|
408
|
-
mergeRequestUrl: string;
|
|
409
|
-
}, "v2">;
|
|
410
|
-
|
|
411
258
|
/**
|
|
412
259
|
* Registry of all registered template actions.
|
|
413
260
|
* @public
|
|
261
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
414
262
|
*/
|
|
415
263
|
declare class TemplateActionRegistry {
|
|
416
264
|
private readonly actions;
|
|
417
|
-
register(action: TemplateAction
|
|
418
|
-
get(actionId: string): TemplateAction
|
|
419
|
-
list(): TemplateAction
|
|
265
|
+
register(action: TemplateAction<any, any, any>): void;
|
|
266
|
+
get(actionId: string): TemplateAction<any, any, any>;
|
|
267
|
+
list(): TemplateAction<any, any, any>[];
|
|
420
268
|
}
|
|
421
269
|
|
|
422
|
-
/**
|
|
423
|
-
* The status of each step of the Task
|
|
424
|
-
*
|
|
425
|
-
* @public
|
|
426
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
427
|
-
*/
|
|
428
|
-
type TaskStatus = TaskStatus$1;
|
|
429
|
-
/**
|
|
430
|
-
* The state of a completed task.
|
|
431
|
-
*
|
|
432
|
-
* @public
|
|
433
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
434
|
-
*/
|
|
435
|
-
type TaskCompletionState = TaskCompletionState$1;
|
|
436
|
-
/**
|
|
437
|
-
* SerializedTask
|
|
438
|
-
*
|
|
439
|
-
* @public
|
|
440
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
441
|
-
*/
|
|
442
|
-
type SerializedTask = SerializedTask$1;
|
|
443
|
-
/**
|
|
444
|
-
* TaskEventType
|
|
445
|
-
*
|
|
446
|
-
* @public
|
|
447
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
448
|
-
*/
|
|
449
|
-
type TaskEventType = TaskEventType$1;
|
|
450
|
-
/**
|
|
451
|
-
* SerializedTaskEvent
|
|
452
|
-
*
|
|
453
|
-
* @public
|
|
454
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
455
|
-
*/
|
|
456
|
-
type SerializedTaskEvent = SerializedTaskEvent$1;
|
|
457
|
-
/**
|
|
458
|
-
* The result of `TaskBroker.dispatch`.
|
|
459
|
-
*
|
|
460
|
-
* @public
|
|
461
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
462
|
-
*/
|
|
463
|
-
type TaskBrokerDispatchResult = TaskBrokerDispatchResult$1;
|
|
464
|
-
/**
|
|
465
|
-
* The options passed to `TaskBroker.dispatch`.
|
|
466
|
-
* Currently a spec and optional secrets
|
|
467
|
-
*
|
|
468
|
-
* @public
|
|
469
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
470
|
-
*/
|
|
471
|
-
type TaskBrokerDispatchOptions = TaskBrokerDispatchOptions$1;
|
|
472
|
-
/**
|
|
473
|
-
* Task
|
|
474
|
-
*
|
|
475
|
-
* @public
|
|
476
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
477
|
-
*/
|
|
478
|
-
type TaskContext = TaskContext$1;
|
|
479
|
-
/**
|
|
480
|
-
* TaskBroker
|
|
481
|
-
*
|
|
482
|
-
* @public
|
|
483
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
484
|
-
*/
|
|
485
|
-
type TaskBroker = TaskBroker$1;
|
|
486
270
|
/**
|
|
487
271
|
* TaskStoreEmitOptions
|
|
488
272
|
*
|
|
489
273
|
* @public
|
|
274
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
490
275
|
*/
|
|
491
276
|
type TaskStoreEmitOptions<TBody = JsonObject> = {
|
|
492
277
|
taskId: string;
|
|
@@ -496,6 +281,7 @@ type TaskStoreEmitOptions<TBody = JsonObject> = {
|
|
|
496
281
|
* TaskStoreListEventsOptions
|
|
497
282
|
*
|
|
498
283
|
* @public
|
|
284
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
499
285
|
*/
|
|
500
286
|
type TaskStoreListEventsOptions = {
|
|
501
287
|
isTaskRecoverable?: boolean;
|
|
@@ -506,6 +292,7 @@ type TaskStoreListEventsOptions = {
|
|
|
506
292
|
* TaskStoreShutDownTaskOptions
|
|
507
293
|
*
|
|
508
294
|
* @public
|
|
295
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
509
296
|
*/
|
|
510
297
|
type TaskStoreShutDownTaskOptions = {
|
|
511
298
|
taskId: string;
|
|
@@ -513,15 +300,17 @@ type TaskStoreShutDownTaskOptions = {
|
|
|
513
300
|
/**
|
|
514
301
|
* The options passed to {@link TaskStore.createTask}
|
|
515
302
|
* @public
|
|
303
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
516
304
|
*/
|
|
517
305
|
type TaskStoreCreateTaskOptions = {
|
|
518
306
|
spec: TaskSpec;
|
|
519
307
|
createdBy?: string;
|
|
520
|
-
secrets?: TaskSecrets
|
|
308
|
+
secrets?: TaskSecrets;
|
|
521
309
|
};
|
|
522
310
|
/**
|
|
523
311
|
* The options passed to {@link TaskStore.recoverTasks}
|
|
524
312
|
* @public
|
|
313
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
525
314
|
*/
|
|
526
315
|
type TaskStoreRecoverTaskOptions = {
|
|
527
316
|
timeout: HumanDuration;
|
|
@@ -529,6 +318,7 @@ type TaskStoreRecoverTaskOptions = {
|
|
|
529
318
|
/**
|
|
530
319
|
* The response from {@link TaskStore.createTask}
|
|
531
320
|
* @public
|
|
321
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
532
322
|
*/
|
|
533
323
|
type TaskStoreCreateTaskResult = {
|
|
534
324
|
taskId: string;
|
|
@@ -537,12 +327,13 @@ type TaskStoreCreateTaskResult = {
|
|
|
537
327
|
* TaskStore
|
|
538
328
|
*
|
|
539
329
|
* @public
|
|
330
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
540
331
|
*/
|
|
541
332
|
interface TaskStore {
|
|
542
333
|
cancelTask?(options: TaskStoreEmitOptions): Promise<void>;
|
|
543
334
|
createTask(options: TaskStoreCreateTaskOptions): Promise<TaskStoreCreateTaskResult>;
|
|
544
335
|
retryTask?(options: {
|
|
545
|
-
secrets?: TaskSecrets
|
|
336
|
+
secrets?: TaskSecrets;
|
|
546
337
|
taskId: string;
|
|
547
338
|
}): Promise<void>;
|
|
548
339
|
recoverTasks?(options: TaskStoreRecoverTaskOptions): Promise<{
|
|
@@ -631,7 +422,7 @@ interface TaskStore {
|
|
|
631
422
|
|
|
632
423
|
/**
|
|
633
424
|
* DatabaseTaskStore
|
|
634
|
-
*
|
|
425
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
635
426
|
* @public
|
|
636
427
|
*/
|
|
637
428
|
type DatabaseTaskStoreOptions = {
|
|
@@ -640,7 +431,7 @@ type DatabaseTaskStoreOptions = {
|
|
|
640
431
|
};
|
|
641
432
|
/**
|
|
642
433
|
* DatabaseTaskStore
|
|
643
|
-
*
|
|
434
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
644
435
|
* @public
|
|
645
436
|
*/
|
|
646
437
|
declare class DatabaseTaskStore implements TaskStore {
|
|
@@ -656,10 +447,10 @@ declare class DatabaseTaskStore implements TaskStore {
|
|
|
656
447
|
private getState;
|
|
657
448
|
list(options: {
|
|
658
449
|
createdBy?: string;
|
|
659
|
-
status?: TaskStatus
|
|
450
|
+
status?: TaskStatus;
|
|
660
451
|
filters?: {
|
|
661
452
|
createdBy?: string | string[];
|
|
662
|
-
status?: TaskStatus
|
|
453
|
+
status?: TaskStatus | TaskStatus[];
|
|
663
454
|
};
|
|
664
455
|
pagination?: {
|
|
665
456
|
limit?: number;
|
|
@@ -670,12 +461,12 @@ declare class DatabaseTaskStore implements TaskStore {
|
|
|
670
461
|
field: string;
|
|
671
462
|
}[];
|
|
672
463
|
}): Promise<{
|
|
673
|
-
tasks: SerializedTask
|
|
464
|
+
tasks: SerializedTask[];
|
|
674
465
|
totalTasks?: number;
|
|
675
466
|
}>;
|
|
676
|
-
getTask(taskId: string): Promise<SerializedTask
|
|
467
|
+
getTask(taskId: string): Promise<SerializedTask>;
|
|
677
468
|
createTask(options: TaskStoreCreateTaskOptions): Promise<TaskStoreCreateTaskResult>;
|
|
678
|
-
claimTask(): Promise<SerializedTask
|
|
469
|
+
claimTask(): Promise<SerializedTask | undefined>;
|
|
679
470
|
heartbeatTask(taskId: string): Promise<void>;
|
|
680
471
|
listStaleTasks(options: {
|
|
681
472
|
timeoutS: number;
|
|
@@ -687,7 +478,7 @@ declare class DatabaseTaskStore implements TaskStore {
|
|
|
687
478
|
}>;
|
|
688
479
|
completeTask(options: {
|
|
689
480
|
taskId: string;
|
|
690
|
-
status: TaskStatus
|
|
481
|
+
status: TaskStatus;
|
|
691
482
|
eventBody: JsonObject;
|
|
692
483
|
}): Promise<void>;
|
|
693
484
|
emitLogEvent(options: TaskStoreEmitOptions<{
|
|
@@ -703,7 +494,7 @@ declare class DatabaseTaskStore implements TaskStore {
|
|
|
703
494
|
state?: JsonObject;
|
|
704
495
|
}): Promise<void>;
|
|
705
496
|
listEvents(options: TaskStoreListEventsOptions): Promise<{
|
|
706
|
-
events: SerializedTaskEvent
|
|
497
|
+
events: SerializedTaskEvent[];
|
|
707
498
|
}>;
|
|
708
499
|
shutdownTask(options: TaskStoreShutDownTaskOptions): Promise<void>;
|
|
709
500
|
rehydrateWorkspace(options: {
|
|
@@ -721,7 +512,7 @@ declare class DatabaseTaskStore implements TaskStore {
|
|
|
721
512
|
message: string;
|
|
722
513
|
} & JsonObject>): Promise<void>;
|
|
723
514
|
retryTask?(options: {
|
|
724
|
-
secrets?: TaskSecrets
|
|
515
|
+
secrets?: TaskSecrets;
|
|
725
516
|
taskId: string;
|
|
726
517
|
}): Promise<void>;
|
|
727
518
|
recoverTasks(options: TaskStoreRecoverTaskOptions): Promise<{
|
|
@@ -731,10 +522,10 @@ declare class DatabaseTaskStore implements TaskStore {
|
|
|
731
522
|
|
|
732
523
|
/**
|
|
733
524
|
* TaskManager
|
|
734
|
-
*
|
|
525
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
735
526
|
* @public
|
|
736
527
|
*/
|
|
737
|
-
declare class TaskManager implements TaskContext
|
|
528
|
+
declare class TaskManager implements TaskContext {
|
|
738
529
|
private readonly task;
|
|
739
530
|
private readonly storage;
|
|
740
531
|
private readonly signal;
|
|
@@ -747,7 +538,7 @@ declare class TaskManager implements TaskContext$1 {
|
|
|
747
538
|
private constructor();
|
|
748
539
|
get spec(): _backstage_plugin_scaffolder_common.TaskSpecV1beta3;
|
|
749
540
|
get cancelSignal(): AbortSignal;
|
|
750
|
-
get secrets(): TaskSecrets
|
|
541
|
+
get secrets(): TaskSecrets | undefined;
|
|
751
542
|
get createdBy(): string | undefined;
|
|
752
543
|
getWorkspaceName(): Promise<string>;
|
|
753
544
|
rehydrateWorkspace?(options: {
|
|
@@ -772,7 +563,7 @@ declare class TaskManager implements TaskContext$1 {
|
|
|
772
563
|
path: string;
|
|
773
564
|
}): Promise<void>;
|
|
774
565
|
cleanWorkspace?(): Promise<void>;
|
|
775
|
-
complete(result: TaskCompletionState
|
|
566
|
+
complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
|
|
776
567
|
private startTimeout;
|
|
777
568
|
getInitiatorCredentials(): Promise<BackstageCredentials>;
|
|
778
569
|
}
|
|
@@ -793,7 +584,7 @@ interface CurrentClaimedTask {
|
|
|
793
584
|
/**
|
|
794
585
|
* The secrets that are stored with the task.
|
|
795
586
|
*/
|
|
796
|
-
secrets?: TaskSecrets
|
|
587
|
+
secrets?: TaskSecrets;
|
|
797
588
|
/**
|
|
798
589
|
* The state of checkpoints of the task.
|
|
799
590
|
*/
|
|
@@ -810,17 +601,17 @@ interface CurrentClaimedTask {
|
|
|
810
601
|
|
|
811
602
|
/**
|
|
812
603
|
* CreateWorkerOptions
|
|
813
|
-
*
|
|
604
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
814
605
|
* @public
|
|
815
606
|
*/
|
|
816
607
|
type CreateWorkerOptions = {
|
|
817
|
-
taskBroker: TaskBroker
|
|
608
|
+
taskBroker: TaskBroker;
|
|
818
609
|
actionRegistry: TemplateActionRegistry;
|
|
819
610
|
integrations: ScmIntegrations;
|
|
820
611
|
workingDirectory: string;
|
|
821
612
|
logger: Logger;
|
|
822
613
|
auditor?: AuditorService;
|
|
823
|
-
additionalTemplateFilters?: Record<string, TemplateFilter
|
|
614
|
+
additionalTemplateFilters?: Record<string, TemplateFilter>;
|
|
824
615
|
/**
|
|
825
616
|
* The number of tasks that can be executed at the same time by the worker
|
|
826
617
|
* @defaultValue 10
|
|
@@ -834,13 +625,13 @@ type CreateWorkerOptions = {
|
|
|
834
625
|
* ```
|
|
835
626
|
*/
|
|
836
627
|
concurrentTasksLimit?: number;
|
|
837
|
-
additionalTemplateGlobals?: Record<string, TemplateGlobal
|
|
628
|
+
additionalTemplateGlobals?: Record<string, TemplateGlobal>;
|
|
838
629
|
permissions?: PermissionEvaluator;
|
|
839
630
|
gracefulShutdown?: boolean;
|
|
840
631
|
};
|
|
841
632
|
/**
|
|
842
633
|
* TaskWorker
|
|
843
|
-
*
|
|
634
|
+
* @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version.
|
|
844
635
|
* @public
|
|
845
636
|
*/
|
|
846
637
|
declare class TaskWorker {
|
|
@@ -855,11 +646,10 @@ declare class TaskWorker {
|
|
|
855
646
|
start(): void;
|
|
856
647
|
stop(): Promise<void>;
|
|
857
648
|
protected onReadyToClaimTask(): Promise<void>;
|
|
858
|
-
runOneTask(task: TaskContext
|
|
649
|
+
runOneTask(task: TaskContext): Promise<void>;
|
|
859
650
|
}
|
|
860
651
|
|
|
861
652
|
/**
|
|
862
|
-
*
|
|
863
653
|
* @public
|
|
864
654
|
*/
|
|
865
655
|
type TemplatePermissionRuleInput<TParams extends PermissionRuleParams = PermissionRuleParams> = PermissionRule<TemplateEntityStepV1beta3 | TemplateParametersV1beta3, {}, typeof RESOURCE_TYPE_SCAFFOLDER_TEMPLATE, TParams>;
|
|
@@ -868,111 +658,5 @@ type TemplatePermissionRuleInput<TParams extends PermissionRuleParams = Permissi
|
|
|
868
658
|
* @public
|
|
869
659
|
*/
|
|
870
660
|
type ActionPermissionRuleInput<TParams extends PermissionRuleParams = PermissionRuleParams> = PermissionRule<TemplateEntityStepV1beta3 | TemplateParametersV1beta3, {}, typeof RESOURCE_TYPE_SCAFFOLDER_ACTION, TParams>;
|
|
871
|
-
/**
|
|
872
|
-
* RouterOptions
|
|
873
|
-
*
|
|
874
|
-
* @public
|
|
875
|
-
* @deprecated Please migrate to the new backend system as this will be removed in the future.
|
|
876
|
-
*/
|
|
877
|
-
interface RouterOptions {
|
|
878
|
-
logger: Logger;
|
|
879
|
-
config: Config;
|
|
880
|
-
reader: UrlReaderService;
|
|
881
|
-
lifecycle?: LifecycleService;
|
|
882
|
-
database: DatabaseService;
|
|
883
|
-
catalogClient: CatalogApi;
|
|
884
|
-
scheduler?: SchedulerService;
|
|
885
|
-
actions?: TemplateAction$1<any, any, any>[];
|
|
886
|
-
/**
|
|
887
|
-
* @deprecated taskWorkers is deprecated in favor of concurrentTasksLimit option with a single TaskWorker
|
|
888
|
-
* @defaultValue 1
|
|
889
|
-
*/
|
|
890
|
-
taskWorkers?: number;
|
|
891
|
-
/**
|
|
892
|
-
* Sets the number of concurrent tasks that can be run at any given time on the TaskWorker
|
|
893
|
-
* @defaultValue 10
|
|
894
|
-
*/
|
|
895
|
-
concurrentTasksLimit?: number;
|
|
896
|
-
taskBroker?: TaskBroker$1;
|
|
897
|
-
additionalTemplateFilters?: Record<string, TemplateFilter$1> | CreatedTemplateFilter<any, any>[];
|
|
898
|
-
additionalTemplateGlobals?: Record<string, TemplateGlobal$1> | CreatedTemplateGlobal[];
|
|
899
|
-
additionalWorkspaceProviders?: Record<string, WorkspaceProvider>;
|
|
900
|
-
permissions?: PermissionsService;
|
|
901
|
-
permissionRules?: Array<TemplatePermissionRuleInput | ActionPermissionRuleInput>;
|
|
902
|
-
auth?: AuthService;
|
|
903
|
-
httpAuth?: HttpAuthService;
|
|
904
|
-
identity?: IdentityApi;
|
|
905
|
-
discovery?: DiscoveryService;
|
|
906
|
-
events?: EventsService;
|
|
907
|
-
auditor?: AuditorService;
|
|
908
|
-
autocompleteHandlers?: Record<string, AutocompleteHandler>;
|
|
909
|
-
}
|
|
910
|
-
/**
|
|
911
|
-
* A method to create a router for the scaffolder backend plugin.
|
|
912
|
-
* @public
|
|
913
|
-
* @deprecated Please migrate to the new backend system as this will be removed in the future.
|
|
914
|
-
*/
|
|
915
|
-
declare function createRouter(options: RouterOptions): Promise<express.Router>;
|
|
916
|
-
|
|
917
|
-
/**
|
|
918
|
-
* @public
|
|
919
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
920
|
-
*/
|
|
921
|
-
type TemplateFilter = TemplateFilter$1;
|
|
922
|
-
/**
|
|
923
|
-
* @public
|
|
924
|
-
* @deprecated Import from `@backstage/plugin-scaffolder-node` instead.
|
|
925
|
-
*/
|
|
926
|
-
type TemplateGlobal = TemplateGlobal$1;
|
|
927
|
-
|
|
928
|
-
/**
|
|
929
|
-
* @public
|
|
930
|
-
* @deprecated Import from {@link @backstage/plugin-scaffolder-node#ActionContext} instead
|
|
931
|
-
*/
|
|
932
|
-
type ActionContext<TInput extends JsonObject> = ActionContext$1<TInput>;
|
|
933
|
-
/**
|
|
934
|
-
* @public
|
|
935
|
-
* @deprecated Use `createTemplateAction` from `@backstage/plugin-scaffolder-node` instead
|
|
936
|
-
*/
|
|
937
|
-
declare const createTemplateAction: typeof createTemplateAction$1;
|
|
938
|
-
/**
|
|
939
|
-
* @public
|
|
940
|
-
* @deprecated Use `TaskSecrets` from `@backstage/plugin-scaffolder-node` instead
|
|
941
|
-
*/
|
|
942
|
-
type TaskSecrets = TaskSecrets$1;
|
|
943
|
-
/**
|
|
944
|
-
* @public
|
|
945
|
-
* @deprecated Use `TemplateAction` from `@backstage/plugin-scaffolder-node` instead
|
|
946
|
-
*/
|
|
947
|
-
type TemplateAction<TInput extends JsonObject> = TemplateAction$1<TInput>;
|
|
948
|
-
/**
|
|
949
|
-
* Options for {@link executeShellCommand}.
|
|
950
|
-
*
|
|
951
|
-
* @public
|
|
952
|
-
* @deprecated Use `ExecuteShellCommandOptions` from `@backstage/plugin-scaffolder-node` instead
|
|
953
|
-
*/
|
|
954
|
-
type RunCommandOptions = ExecuteShellCommandOptions;
|
|
955
|
-
/**
|
|
956
|
-
* Run a command in a sub-process, normally a shell command.
|
|
957
|
-
*
|
|
958
|
-
* @public
|
|
959
|
-
* @deprecated Use `executeShellCommand` from `@backstage/plugin-scaffolder-node` instead
|
|
960
|
-
*/
|
|
961
|
-
declare const executeShellCommand: typeof executeShellCommand$1;
|
|
962
|
-
/**
|
|
963
|
-
* A helper function that reads the contents of a directory from the given URL.
|
|
964
|
-
* Can be used in your own actions, and also used behind fetch:template and fetch:plain
|
|
965
|
-
*
|
|
966
|
-
* @public
|
|
967
|
-
* @deprecated Use `fetchContents` from `@backstage/plugin-scaffolder-node` instead
|
|
968
|
-
*/
|
|
969
|
-
declare const fetchContents: typeof fetchContents$1;
|
|
970
|
-
/**
|
|
971
|
-
* Adds support for scaffolder specific entity kinds to the catalog.
|
|
972
|
-
*
|
|
973
|
-
* @public
|
|
974
|
-
* @deprecated Import from `@backstage/plugin-catalog-backend-module-scaffolder-entity-model` instead
|
|
975
|
-
*/
|
|
976
|
-
declare const ScaffolderEntitiesProcessor: typeof ScaffolderEntitiesProcessor$1;
|
|
977
661
|
|
|
978
|
-
export { type
|
|
662
|
+
export { type ActionPermissionRuleInput, type CreateBuiltInActionsOptions, type CreateWorkerOptions, type CurrentClaimedTask, DatabaseTaskStore, type DatabaseTaskStoreOptions, TaskManager, type TaskStore, type TaskStoreCreateTaskOptions, type TaskStoreCreateTaskResult, type TaskStoreEmitOptions, type TaskStoreListEventsOptions, type TaskStoreRecoverTaskOptions, type TaskStoreShutDownTaskOptions, TaskWorker, TemplateActionRegistry, type TemplatePermissionRuleInput, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFetchTemplateFileAction, createFilesystemDeleteAction, createFilesystemReadDirAction, createFilesystemRenameAction, createWaitAction, scaffolderPlugin as default };
|