@backstage/plugin-scaffolder-backend 0.15.18 → 0.15.21

package/dist/index.d.ts

@@ -1,11 +1,13 @@
 /// <reference types="node" />
-import { ScmIntegrations, ScmIntegrationRegistry } from '@backstage/integration';
+import { ScmIntegrations, ScmIntegrationRegistry, GithubCredentialsProvider } from '@backstage/integration';
 import { CatalogApi } from '@backstage/catalog-client';
 import { Logger } from 'winston';
 import { Writable } from 'stream';
 import * as _backstage_types from '@backstage/types';
 import { JsonValue, JsonObject } from '@backstage/types';
 import { Schema } from 'jsonschema';
+import { TaskSpec, TemplateMetadata } from '@backstage/plugin-scaffolder-common';
+export { TaskSpec, TaskSpecV1beta2, TaskSpecV1beta3, TemplateMetadata } from '@backstage/plugin-scaffolder-common';
 import { UrlReader, ContainerRunner, PluginDatabaseManager } from '@backstage/backend-common';
 import { Config } from '@backstage/config';
 import { createPullRequest } from 'octokit-plugin-create-pull-request';
@@ -82,6 +84,7 @@ declare function createPublishFileAction(): TemplateAction<any>;
 declare function createPublishGithubAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
+    githubCredentialsProvider?: GithubCredentialsProvider;
 }): TemplateAction<any>;
 
 declare type CreatePullRequestResponse = {
@@ -94,15 +97,17 @@ interface PullRequestCreator {
 }
 declare type ClientFactoryInput = {
     integrations: ScmIntegrationRegistry;
+    githubCredentialsProvider?: GithubCredentialsProvider;
     host: string;
     owner: string;
     repo: string;
 };
 interface CreateGithubPullRequestActionOptions {
     integrations: ScmIntegrationRegistry;
+    githubCredentialsProvider?: GithubCredentialsProvider;
     clientFactory?: (input: ClientFactoryInput) => Promise<PullRequestCreator>;
 }
-declare const createPublishGithubPullRequestAction: ({ integrations, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction<any>;
+declare const createPublishGithubPullRequestAction: ({ integrations, githubCredentialsProvider, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction<any>;
 
 declare function createPublishGitlabAction(options: {
     integrations: ScmIntegrationRegistry;
@@ -114,12 +119,14 @@ declare const createPublishGitlabMergeRequestAction: (options: {
 }) => TemplateAction<any>;
 
 declare function createGithubActionsDispatchAction(options: {
-    integrations: ScmIntegrationRegistry;
+    integrations: ScmIntegrations;
+    githubCredentialsProvider?: GithubCredentialsProvider;
 }): TemplateAction<any>;
 
 declare function createGithubWebhookAction(options: {
     integrations: ScmIntegrationRegistry;
     defaultWebhookSecret?: string;
+    githubCredentialsProvider?: GithubCredentialsProvider;
 }): TemplateAction<any>;
 
 declare type OctokitIntegration = {
@@ -134,12 +141,12 @@ declare type OctokitIntegration = {
  */
 declare class OctokitProvider {
     private readonly integrations;
-    private readonly credentialsProviders;
-    constructor(integrations: ScmIntegrationRegistry);
+    private readonly githubCredentialsProvider;
+    constructor(integrations: ScmIntegrationRegistry, githubCredentialsProvider?: GithubCredentialsProvider);
     /**
      * gets standard Octokit client based on repository URL.
      *
-     * @param repoUrl Repository URL
+     * @param repoUrl - Repository URL
      */
     getOctokit(repoUrl: string): Promise<OctokitIntegration>;
 }
@@ -202,70 +209,15 @@ declare type SerializedTaskEvent = {
     type: TaskEventType;
     createdAt: string;
 };
-/**
- * TemplateMetadata
- *
- * @public
- */
-declare type TemplateMetadata = {
-    name: string;
-};
-/**
- * TaskSpecV1beta2
- *
- * @public
- */
-interface TaskSpecV1beta2 {
-    apiVersion: 'backstage.io/v1beta2';
-    baseUrl?: string;
-    values: JsonObject;
-    steps: Array<{
-        id: string;
-        name: string;
-        action: string;
-        input?: JsonObject;
-        if?: string | boolean;
-    }>;
-    output: {
-        [name: string]: string;
-    };
-    metadata?: TemplateMetadata;
-}
-interface TaskStep {
-    id: string;
-    name: string;
-    action: string;
-    input?: JsonObject;
-    if?: string | boolean;
-}
-/**
- * TaskSpecV1beta3
- *
- * @public
- */
-interface TaskSpecV1beta3 {
-    apiVersion: 'scaffolder.backstage.io/v1beta3';
-    baseUrl?: string;
-    parameters: JsonObject;
-    steps: TaskStep[];
-    output: {
-        [name: string]: JsonValue;
-    };
-    metadata?: TemplateMetadata;
-}
-/**
- * TaskSpec
- *
- * @public
- */
-declare type TaskSpec = TaskSpecV1beta2 | TaskSpecV1beta3;
 /**
  * TaskSecrets
  *
  * @public
  */
-declare type TaskSecrets = {
-    token: string | undefined;
+declare type TaskSecrets = Record<string, string> & {
+    /** @deprecated Use `backstageToken` instead */
+    token?: string;
+    backstageToken?: string;
 };
 /**
  * DispatchResult
@@ -371,8 +323,10 @@ declare type ActionContext<Input extends InputBase> = {
     logStream: Writable;
     /**
      * User token forwarded from initial request, for use in subsequent api requests
+     * @deprecated use `secrets.backstageToken` instead
      */
     token?: string | undefined;
+    secrets?: TaskSecrets;
     workspacePath: string;
     input: Input;
     output(name: string, value: JsonValue): void;
@@ -542,4 +496,4 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
-export { ActionContext, CatalogEntityClient, CompletedTaskState, CreateWorkerOptions, DatabaseTaskStore, DispatchResult, OctokitProvider, RouterOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, Status, TaskBroker, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskSpec, TaskSpecV1beta2, TaskSpecV1beta3, TaskState, TaskStore, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateMetadata, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, fetchContents, runCommand };
+export { ActionContext, CatalogEntityClient, CompletedTaskState, CreateWorkerOptions, DatabaseTaskStore, DispatchResult, OctokitProvider, RouterOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, Status, TaskBroker, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskState, TaskStore, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, fetchContents, runCommand };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
   "description": "The Backstage backend plugin that helps you create new things",
-  "version": "0.15.18",
+  "version": "0.15.21",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -31,15 +31,15 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.10.0",
-    "@backstage/catalog-client": "^0.5.3",
-    "@backstage/catalog-model": "^0.9.8",
-    "@backstage/config": "^0.1.11",
-    "@backstage/errors": "^0.1.5",
-    "@backstage/integration": "^0.6.10",
-    "@backstage/plugin-catalog-backend": "^0.19.3",
-    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.6",
-    "@backstage/plugin-scaffolder-common": "^0.1.1",
+    "@backstage/backend-common": "^0.10.4",
+    "@backstage/catalog-client": "^0.5.5",
+    "@backstage/catalog-model": "^0.9.10",
+    "@backstage/config": "^0.1.13",
+    "@backstage/errors": "^0.2.0",
+    "@backstage/integration": "^0.7.2",
+    "@backstage/plugin-catalog-backend": "^0.21.0",
+    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.9",
+    "@backstage/plugin-scaffolder-common": "^0.1.3",
     "@backstage/types": "^0.1.1",
     "@gitbeaker/core": "^34.6.0",
     "@gitbeaker/node": "^34.6.0",
@@ -73,8 +73,8 @@
     "yaml": "^1.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.10.3",
-    "@backstage/test-utils": "^0.2.0",
+    "@backstage/cli": "^0.12.0",
+    "@backstage/test-utils": "^0.2.3",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -95,5 +95,5 @@
     "assets"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "b315430f9dfcfa19ab0dd90f5b4ac6904938fba7"
+  "gitHead": "600d6e3c854bbfb12a0078ca6f726d1c0d1fea0b"
 }