Added onTaskComplete option

action-src/main.ts

@@ -2,7 +2,7 @@ import { error, getInput, setFailed, setOutput } from '@actions/core';
 import { context } from '@actions/github';
 import path from 'path';
 
-import { run as runNode } from '../node-src';
+import { runChromaticFull } from '../node-src';
 
 const maybe = (a: string, b: any = undefined) => {
   if (!a) {
@@ -108,35 +108,36 @@ async function run() {
 
     process.chdir(path.join(process.cwd(), workingDir || ''));
 
-    const output = await runNode({
-      allowConsoleErrors: maybe(allowConsoleErrors, false),
-      autoAcceptChanges: maybe(autoAcceptChanges),
-      branchName: maybe(branchName),
-      buildScriptName: maybe(buildScriptName),
-      debug: maybe(debug),
-      diagnostics: maybe(diagnostics),
-      dryRun: maybe(dryRun),
-      exitOnceUploaded: maybe(exitOnceUploaded, false),
-      exitZeroOnChanges: maybe(exitZeroOnChanges, true),
-      externals: maybe(externals),
-      forceRebuild: maybe(forceRebuild),
-      ignoreLastBuildOnBranch: maybe(ignoreLastBuildOnBranch),
-      interactive: false,
-      only: maybe(only),
-      onlyChanged: maybe(onlyChanged),
-      onlyStoryFiles: maybe(onlyStoryFiles),
-      onlyStoryNames: maybe(onlyStoryNames),
-      preserveMissing: maybe(preserveMissing),
-      projectToken,
-      repositorySlug: maybe(repositorySlug),
-      skip: maybe(skip),
-      storybookBaseDir: maybe(storybookBaseDir),
-      storybookBuildDir: maybe(storybookBuildDir),
-      storybookConfigDir: maybe(storybookConfigDir),
-      traceChanged: maybe(traceChanged),
-      untraced: maybe(untraced),
-      zip: maybe(zip, false),
-      junitReport: maybe(junitReport, false),
+    const output = await runChromaticFull({
+      flags: {
+        allowConsoleErrors: maybe(allowConsoleErrors, false),
+        autoAcceptChanges: maybe(autoAcceptChanges),
+        branchName: maybe(branchName),
+        buildScriptName: maybe(buildScriptName),
+        debug: maybe(debug),
+        diagnostics: maybe(diagnostics),
+        dryRun: maybe(dryRun),
+        exitOnceUploaded: maybe(exitOnceUploaded, false),
+        exitZeroOnChanges: maybe(exitZeroOnChanges, true),
+        externals: maybe(externals),
+        forceRebuild: maybe(forceRebuild),
+        ignoreLastBuildOnBranch: maybe(ignoreLastBuildOnBranch),
+        interactive: false,
+        only: maybe(only),
+        onlyChanged: maybe(onlyChanged),
+        onlyStoryFiles: maybe(onlyStoryFiles),
+        onlyStoryNames: maybe(onlyStoryNames),
+        preserveMissing: maybe(preserveMissing),
+        projectToken,
+        repositorySlug: maybe(repositorySlug),
+        skip: maybe(skip),
+        storybookBaseDir: maybe(storybookBaseDir),
+        storybookBuildDir: maybe(storybookBuildDir),
+        storybookConfigDir: maybe(storybookConfigDir),
+        traceChanged: maybe(traceChanged),
+        untraced: maybe(untraced),
+        zip: maybe(zip, false),
+      },
     });
 
     Object.entries(output).forEach(([key, value]) => setOutput(key, String(value)));

bin-src/lib/getOptions.ts

@@ -25,7 +25,10 @@ const undefinedIfEmpty = <T>(array: T[]) => {
   return filtered.length ? filtered : undefined;
 };
 
-export default function getOptions({ argv, env, flags, log, packageJson }: Context): Options {
+export default function getOptions(
+  { argv, env, flags, log, packageJson }: Context,
+  extraOptions: Partial<Options> = {}
+): Options {
   const fromCI = !!flags.ci || !!process.env.CI;
   const [patchHeadRef, patchBaseRef] = (flags.patchBuild || '').split('...').filter(Boolean);
   const [branchName, branchOwner] = (flags.branchName || '').split(':').reverse();
@@ -75,6 +78,7 @@ export default function getOptions({ argv, env, flags, log, packageJson }: Conte
     branchName,
     patchHeadRef,
     patchBaseRef,
+    ...extraOptions,
   };
 
   if (flags.debug) {

bin-src/lib/tasks.ts

@@ -15,6 +15,8 @@ export const createTask = ({ title, steps, ...config }): Listr.ListrTask<Context
       // eslint-disable-next-line no-await-in-loop
       await step(ctx, task);
     }
+
+    ctx.options.onTaskComplete?.(ctx);
   },
   ...config,
 });

bin-src/main.ts

@@ -15,7 +15,7 @@ import { exitCodes, setExitCode } from './lib/setExitCode';
 import { rewriteErrorMessage } from './lib/utils';
 import { writeChromaticDiagnostics } from './lib/writeChromaticDiagnostics';
 import getTasks from './tasks';
-import { Context } from './types';
+import { Context, Options } from './types';
 import fatalError from './ui/messages/errors/fatalError';
 import fetchError from './ui/messages/errors/fetchError';
 import graphqlError from './ui/messages/errors/graphqlError';
@@ -60,13 +60,13 @@ export async function main(argv: string[]) {
   process.exit(ctx.exitCode);
 }
 
-export async function runAll(ctx) {
+export async function runAll(ctx, extraOptions?: Partial<Options>) {
   setExitCode(ctx, exitCodes.OK);
 
   ctx.http = (ctx.http as HTTPClient) || new HTTPClient(ctx);
 
   // Run these in parallel; neither should ever reject
-  await Promise.all([runBuild(ctx), checkForUpdates(ctx)]);
+  await Promise.all([runBuild(ctx, extraOptions), checkForUpdates(ctx)]);
 
   if (ctx.exitCode === 0 || ctx.exitCode === 1) {
     await checkPackageJson(ctx);
@@ -77,12 +77,12 @@ export async function runAll(ctx) {
   }
 }
 
-export async function runBuild(ctx: Context) {
+export async function runBuild(ctx: Context, extraOptions?: Partial<Options>) {
   ctx.log.info('');
   ctx.log.info(intro(ctx));
 
   try {
-    ctx.options = await getOptions(ctx);
+    ctx.options = await getOptions(ctx, extraOptions);
   } catch (e) {
     ctx.log.info('');
     ctx.log.error(fatalError(ctx, [e]));

bin-src/types.ts

@@ -86,6 +86,9 @@ export interface Options {
   branchName: string;
   patchHeadRef: string;
   patchBaseRef: string;
+
+  /** A callback that is called at the completion of each task */
+  onTaskComplete?: (ctx: Context) => void;
 }
 
 export interface Context {

node-src/index.ts

@@ -7,7 +7,7 @@ import getEnv from '../bin-src/lib/getEnv';
 import { createLogger } from '../bin-src/lib/log';
 import parseArgs from '../bin-src/lib/parseArgs';
 import { runAll } from '../bin-src/main';
-import { Context, Flags } from '../bin-src/types';
+import { Context, Flags, Options } from '../bin-src/types';
 
 interface Output {
   code: number;
@@ -25,7 +25,13 @@ interface Output {
   inheritedCaptureCount: number;
 }
 
-export async function run(flags: Flags): Promise<Output> {
+export async function runChromaticFull({
+  flags = {},
+  options = {},
+}: {
+  flags?: Flags;
+  options?: Partial<Options>;
+}): Promise<Output> {
   const sessionId = uuid();
   const env = getEnv();
   const log = createLogger(sessionId, env);
@@ -41,7 +47,7 @@ export async function run(flags: Flags): Promise<Output> {
     sessionId,
     flags,
   };
-  await runAll(ctx);
+  await runAll(ctx, options);
 
   return {
     // Keep this in sync with the configured outputs in action.yml
@@ -60,3 +66,7 @@ export async function run(flags: Flags): Promise<Output> {
     inheritedCaptureCount: ctx.build?.inheritedCaptureCount,
   };
 }
+
+export async function run(options: Partial<Options>): Promise<Output> {
+  return runChromaticFull({ options });
+}