@backstage/plugin-scaffolder-backend 0.0.0-nightly-20220307022304 → 0.0.0-nightly-20220310022859
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 +67 -6
- package/dist/index.cjs.js +39 -238
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +4 -46
- package/migrations/20210120143715_init.js +1 -1
- package/package.json +9 -10
package/dist/index.d.ts
CHANGED
|
@@ -5,7 +5,8 @@ import { Logger } from 'winston';
|
|
|
5
5
|
import { Writable } from 'stream';
|
|
6
6
|
import { JsonValue, JsonObject, Observable } from '@backstage/types';
|
|
7
7
|
import { Schema } from 'jsonschema';
|
|
8
|
-
import
|
|
8
|
+
import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
|
|
9
|
+
import { TaskSpec, TemplateInfo } from '@backstage/plugin-scaffolder-common';
|
|
9
10
|
import { Entity } from '@backstage/catalog-model';
|
|
10
11
|
import { UrlReader, PluginDatabaseManager } from '@backstage/backend-common';
|
|
11
12
|
import { Config } from '@backstage/config';
|
|
@@ -49,26 +50,12 @@ declare type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
|
|
|
49
50
|
* @public
|
|
50
51
|
*/
|
|
51
52
|
declare type TaskStatus = 'open' | 'processing' | 'failed' | 'cancelled' | 'completed';
|
|
52
|
-
/**
|
|
53
|
-
* The status of each step of the Task
|
|
54
|
-
*
|
|
55
|
-
* @public
|
|
56
|
-
* @deprecated use TaskStatus instead
|
|
57
|
-
*/
|
|
58
|
-
declare type Status = TaskStatus;
|
|
59
53
|
/**
|
|
60
54
|
* The state of a completed task.
|
|
61
55
|
*
|
|
62
56
|
* @public
|
|
63
57
|
*/
|
|
64
58
|
declare type TaskCompletionState = 'failed' | 'completed';
|
|
65
|
-
/**
|
|
66
|
-
* The state of a completed task.
|
|
67
|
-
*
|
|
68
|
-
* @public
|
|
69
|
-
* @deprecated use TaskCompletionState instead
|
|
70
|
-
*/
|
|
71
|
-
declare type CompletedTaskState = TaskCompletionState;
|
|
72
59
|
/**
|
|
73
60
|
* SerializedTask
|
|
74
61
|
*
|
|
@@ -126,13 +113,6 @@ declare type TaskBrokerDispatchOptions = {
|
|
|
126
113
|
spec: TaskSpec;
|
|
127
114
|
secrets?: TaskSecrets;
|
|
128
115
|
};
|
|
129
|
-
/**
|
|
130
|
-
* DispatchResult
|
|
131
|
-
*
|
|
132
|
-
* @public
|
|
133
|
-
* @deprecated use TaskBrokerDispatchResult instead
|
|
134
|
-
*/
|
|
135
|
-
declare type DispatchResult = TaskBrokerDispatchResult;
|
|
136
116
|
/**
|
|
137
117
|
* Task
|
|
138
118
|
*
|
|
@@ -231,11 +211,6 @@ interface TaskStore {
|
|
|
231
211
|
* @public
|
|
232
212
|
*/
|
|
233
213
|
declare type ActionContext<Input extends JsonObject> = {
|
|
234
|
-
/**
|
|
235
|
-
* Base URL for the location of the task spec, typically the url of the source entity file.
|
|
236
|
-
* @deprecated please use templateInfo.baseUrl instead
|
|
237
|
-
*/
|
|
238
|
-
baseUrl?: string;
|
|
239
214
|
logger: Logger;
|
|
240
215
|
logStream: Writable;
|
|
241
216
|
secrets?: TaskSecrets;
|
|
@@ -246,10 +221,6 @@ declare type ActionContext<Input extends JsonObject> = {
|
|
|
246
221
|
* Creates a temporary directory for use by the action, which is then cleaned up automatically.
|
|
247
222
|
*/
|
|
248
223
|
createTemporaryDirectory(): Promise<string>;
|
|
249
|
-
/**
|
|
250
|
-
* @deprecated please use templateInfo instead
|
|
251
|
-
*/
|
|
252
|
-
metadata?: TemplateMetadata;
|
|
253
224
|
templateInfo?: TemplateInfo;
|
|
254
225
|
};
|
|
255
226
|
/** @public */
|
|
@@ -568,12 +539,6 @@ declare type RunCommandOptions = {
|
|
|
568
539
|
* @public
|
|
569
540
|
*/
|
|
570
541
|
declare const executeShellCommand: (options: RunCommandOptions) => Promise<void>;
|
|
571
|
-
/**
|
|
572
|
-
* Run a command in a sub-process, normally a shell command.
|
|
573
|
-
* @public
|
|
574
|
-
* @deprecated use {@link executeShellCommand} instead
|
|
575
|
-
*/
|
|
576
|
-
declare const runCommand: (options: RunCommandOptions) => Promise<void>;
|
|
577
542
|
|
|
578
543
|
/**
|
|
579
544
|
* Registry of all registered template actions.
|
|
@@ -646,7 +611,7 @@ declare class TaskManager implements TaskContext {
|
|
|
646
611
|
private heartbeatTimeoutId?;
|
|
647
612
|
static create(task: CurrentClaimedTask, storage: TaskStore, logger: Logger): TaskManager;
|
|
648
613
|
private constructor();
|
|
649
|
-
get spec():
|
|
614
|
+
get spec(): _backstage_plugin_scaffolder_common.TaskSpecV1beta3;
|
|
650
615
|
get secrets(): TaskSecrets | undefined;
|
|
651
616
|
getWorkspaceName(): Promise<string>;
|
|
652
617
|
get done(): boolean;
|
|
@@ -664,13 +629,6 @@ interface CurrentClaimedTask {
|
|
|
664
629
|
taskId: string;
|
|
665
630
|
secrets?: TaskSecrets;
|
|
666
631
|
}
|
|
667
|
-
/**
|
|
668
|
-
* TaskState
|
|
669
|
-
*
|
|
670
|
-
* @public
|
|
671
|
-
* @deprecated use CurrentClaimedTask instead
|
|
672
|
-
*/
|
|
673
|
-
declare type TaskState = CurrentClaimedTask;
|
|
674
632
|
|
|
675
633
|
/**
|
|
676
634
|
* CreateWorkerOptions
|
|
@@ -725,4 +683,4 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
|
|
|
725
683
|
postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
|
|
726
684
|
}
|
|
727
685
|
|
|
728
|
-
export { ActionContext,
|
|
686
|
+
export { ActionContext, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, executeShellCommand, fetchContents };
|
|
@@ -75,7 +75,7 @@ exports.up = async function up(knex) {
|
|
|
75
75
|
* @param {import('knex').Knex} knex
|
|
76
76
|
*/
|
|
77
77
|
exports.down = async function down(knex) {
|
|
78
|
-
if (knex.client.config.client
|
|
78
|
+
if (!knex.client.config.client.includes('sqlite3')) {
|
|
79
79
|
await knex.schema.alterTable('task_events', table => {
|
|
80
80
|
table.dropIndex([], 'task_events_task_id_idx');
|
|
81
81
|
});
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-scaffolder-backend",
|
|
3
3
|
"description": "The Backstage backend plugin that helps you create new things",
|
|
4
|
-
"version": "0.0.0-nightly-
|
|
4
|
+
"version": "0.0.0-nightly-20220310022859",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -34,14 +34,14 @@
|
|
|
34
34
|
"build:assets": "node scripts/build-nunjucks.js"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@backstage/backend-common": "^0.0.0-nightly-
|
|
38
|
-
"@backstage/catalog-client": "^0.0.0-nightly-
|
|
39
|
-
"@backstage/catalog-model": "^0.0.0-nightly-
|
|
37
|
+
"@backstage/backend-common": "^0.0.0-nightly-20220310022859",
|
|
38
|
+
"@backstage/catalog-client": "^0.0.0-nightly-20220310022859",
|
|
39
|
+
"@backstage/catalog-model": "^0.0.0-nightly-20220310022859",
|
|
40
40
|
"@backstage/config": "^0.1.15",
|
|
41
41
|
"@backstage/errors": "^0.2.2",
|
|
42
42
|
"@backstage/integration": "^0.8.0",
|
|
43
|
-
"@backstage/plugin-catalog-backend": "^0.0.0-nightly-
|
|
44
|
-
"@backstage/plugin-scaffolder-common": "^0.0.0-nightly-
|
|
43
|
+
"@backstage/plugin-catalog-backend": "^0.0.0-nightly-20220310022859",
|
|
44
|
+
"@backstage/plugin-scaffolder-common": "^0.0.0-nightly-20220310022859",
|
|
45
45
|
"@backstage/types": "^0.1.3",
|
|
46
46
|
"@gitbeaker/core": "^34.6.0",
|
|
47
47
|
"@gitbeaker/node": "^35.1.0",
|
|
@@ -53,10 +53,9 @@
|
|
|
53
53
|
"cors": "^2.8.5",
|
|
54
54
|
"express": "^4.17.1",
|
|
55
55
|
"express-promise-router": "^4.1.0",
|
|
56
|
-
"fs-extra": "10.0.
|
|
56
|
+
"fs-extra": "10.0.1",
|
|
57
57
|
"git-url-parse": "^11.6.0",
|
|
58
58
|
"globby": "^11.0.0",
|
|
59
|
-
"handlebars": "^4.7.6",
|
|
60
59
|
"isbinaryfile": "^4.0.8",
|
|
61
60
|
"isomorphic-git": "^1.8.0",
|
|
62
61
|
"jsonschema": "^1.2.6",
|
|
@@ -75,8 +74,8 @@
|
|
|
75
74
|
"zen-observable": "^0.8.15"
|
|
76
75
|
},
|
|
77
76
|
"devDependencies": {
|
|
78
|
-
"@backstage/
|
|
79
|
-
"@backstage/
|
|
77
|
+
"@backstage/backend-test-utils": "^0.0.0-nightly-20220310022859",
|
|
78
|
+
"@backstage/cli": "^0.0.0-nightly-20220310022859",
|
|
80
79
|
"@types/command-exists": "^1.2.0",
|
|
81
80
|
"@types/fs-extra": "^9.0.1",
|
|
82
81
|
"@types/git-url-parse": "^9.0.0",
|