scaffolder,scaffolder-backend: fix API reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

plugins/scaffolder-backend/api-report.md

@@ -40,6 +40,7 @@ export type ActionContext<Input extends JsonObject> = {
   output(name: string, value: JsonValue): void;
   createTemporaryDirectory(): Promise<string>;
   templateInfo?: TemplateInfo;
+  isDryRun?: boolean;
 };
 
 // @public
@@ -550,6 +551,8 @@ export interface TaskContext {
   // (undocumented)
   getWorkspaceName(): Promise<string>;
   // (undocumented)
+  isDryRun?: boolean;
+  // (undocumented)
   secrets?: TaskSecrets;
   // (undocumented)
   spec: TaskSpec;
@@ -665,6 +668,7 @@ export class TaskWorker {
 export type TemplateAction<Input extends JsonObject> = {
   id: string;
   description?: string;
+  supportsDryRun?: boolean;
   schema?: {
     input?: Schema;
     output?: Schema;

plugins/scaffolder/api-report.md

@@ -25,6 +25,7 @@ import { default as React_2 } from 'react';
 import { RouteRef } from '@backstage/core-plugin-api';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { TaskSpec } from '@backstage/plugin-scaffolder-common';
+import { TaskStep } from '@backstage/plugin-scaffolder-common';
 import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
 
 // @public
@@ -226,6 +227,8 @@ export type RouterProps = {
 
 // @public
 export interface ScaffolderApi {
+  // (undocumented)
+  dryRun?(options: ScaffolderDryRunOptions): Promise<ScaffolderDryRunResponse>;
   // (undocumented)
   getIntegrationsList(
     options: ScaffolderGetIntegrationsListOptions,
@@ -256,6 +259,8 @@ export class ScaffolderClient implements ScaffolderApi {
     useLongPollingLogs?: boolean;
   });
   // (undocumented)
+  dryRun(options: ScaffolderDryRunOptions): Promise<ScaffolderDryRunResponse>;
+  // (undocumented)
   getIntegrationsList(
     options: ScaffolderGetIntegrationsListOptions,
   ): Promise<ScaffolderGetIntegrationsListResponse>;
@@ -274,6 +279,37 @@ export class ScaffolderClient implements ScaffolderApi {
   streamLogs(options: ScaffolderStreamLogsOptions): Observable<LogEvent>;
 }
 
+// @public (undocumented)
+export interface ScaffolderDryRunOptions {
+  // (undocumented)
+  content: {
+    path: string;
+    base64Content: string;
+  }[];
+  // (undocumented)
+  secrets: JsonObject;
+  // (undocumented)
+  template: JsonValue;
+  // (undocumented)
+  values: JsonObject;
+}
+
+// @public (undocumented)
+export interface ScaffolderDryRunResponse {
+  // (undocumented)
+  content: Array<{
+    path: string;
+    base64Content: string;
+    executable: boolean;
+  }>;
+  // (undocumented)
+  log: Array<LogEvent['body']>;
+  // (undocumented)
+  output: ScaffolderTaskOutput;
+  // (undocumented)
+  steps: TaskStep[];
+}
+
 // @public
 export const ScaffolderFieldExtensions: React_2.ComponentType;
 

plugins/scaffolder/src/index.ts

@@ -25,6 +25,8 @@ export type {
   ListActionsResponse,
   LogEvent,
   ScaffolderApi,
+  ScaffolderDryRunOptions,
+  ScaffolderDryRunResponse,
   ScaffolderGetIntegrationsListOptions,
   ScaffolderGetIntegrationsListResponse,
   ScaffolderOutputLink,

plugins/scaffolder/src/types.ts

@@ -150,6 +150,7 @@ export interface ScaffolderStreamLogsOptions {
   after?: number;
 }
 
+/** @public */
 export interface ScaffolderDryRunOptions {
   template: JsonValue;
   values: JsonObject;
@@ -157,6 +158,7 @@ export interface ScaffolderDryRunOptions {
   content: { path: string; base64Content: string }[];
 }
 
+/** @public */
 export interface ScaffolderDryRunResponse {
   content: Array<{
     path: string;