@quadnix/octo-build 0.0.17 → 0.1.0

package/README.md

@@ -1,5 +1,6 @@
 # Octo
-http://octo.quadnix.com/
+
+https://octo.quadnix.com/
 
 The open-source infrastructure management and CICD tool.
 
@@ -8,6 +9,27 @@ The open-source infrastructure management and CICD tool.
 > We plan to release version `1.x.x` when it is deemed ready for production use.
 
 # Local Setup
-> npm install
 
-> npm run prepare
+## Prerequisites
+
+- [Node.js](https://nodejs.org) 22 (LTS). This ships with Corepack, which provisions the
+  exact package manager the project expects — you do **not** need to install pnpm yourself.
+
+## Install
+
+This repository is a [pnpm](https://pnpm.io) workspace. Corepack reads the `packageManager`
+field in the root `package.json` and uses the pnpm version pinned there, so everyone (and CI)
+runs the same version.
+
+```sh
+# One-time per machine: activate Corepack so the `pnpm` command uses the pinned version.
+corepack enable
+
+# Install all workspace dependencies (packages/*).
+pnpm install
+```
+
+> **Note:** The documentation site under `apps/octo-docs` is an intentionally separate
+> project — it consumes the published `@quadnix/*` packages from the registry rather than the
+> local source. It is not part of the root workspace and is only installed (with its own
+> `pnpm install`, run from inside that directory) when you are working on the docs.

package/dist/commands/apply/apply.command.d.ts

@@ -0,0 +1,25 @@
+import type { ArgumentsCamelCase, Argv } from 'yargs';
+type ApplyCommandArguments = {
+    autoApprove?: boolean;
+    lockId: string;
+    terraformBinary?: string;
+    terragruntBinary?: string;
+    terragruntDir: string;
+    timeoutInMs?: number;
+};
+/**
+ * Step 3 of the octo lifecycle, and the only one that changes live infrastructure.
+ *
+ * Unlike generate and validate, this is a terraform action rather than an octo mode - it composes no
+ * model graph and reads no model or resource state. What it does need is the state provider, both
+ * because terraform's own state is checked out of it before every terraform command and back in
+ * after, and because this is one of the two commands that require the app lock. It refuses to run
+ * when the plan would destroy anything, unless `--auto-approve` is passed.
+ */
+export declare const applyCommand: {
+    builder: (yargs: Argv) => Argv;
+    command: string;
+    describe: string;
+    handler: (argv: ArgumentsCamelCase<ApplyCommandArguments>) => Promise<void>;
+};
+export {};

package/dist/commands/apply/apply.command.js

@@ -0,0 +1,136 @@
+import { resolve } from 'path';
+import { Container, StateManagementService, TerraformUtility } from '@quadnix/octo';
+import chalk from 'chalk';
+import { bootStateProvider, prepareCallbackEnvironment, reportError } from '../../utilities/octo/octo.utility.js';
+/**
+ * Plans the directory and prints anything the apply would destroy.
+ *
+ * Returns true when the apply must not proceed: something would be destroyed, or a folder would not
+ * plan and so nothing can be said about what it would destroy.
+ */
+async function isBlockedByDestroys(terraformUtility, resolvedDir) {
+    const { errors, plans } = await terraformUtility.plan(resolvedDir, { json: true });
+    if (errors.size > 0) {
+        for (const [moduleId, error] of errors.entries()) {
+            console.error(chalk.red(`ERROR [${moduleId}] Terraform failed to plan:\n${error}`));
+        }
+        console.error(chalk.red('\nCannot check this apply for destroys because the folders above would not plan. ' +
+            'Fix them, or pass --auto-approve to apply anyway.'));
+        return true;
+    }
+    const destroys = terraformUtility.findPlannedDestroys(plans);
+    if (destroys.length === 0) {
+        return false;
+    }
+    console.error(chalk.red('This apply would DESTROY:'));
+    for (const destroy of destroys.sort((a, b) => a.address.localeCompare(b.address))) {
+        console.error(chalk.red(`  [${destroy.moduleId}] ${destroy.address} (${destroy.tfActions.join(', ')})`));
+    }
+    console.error(chalk.red('\nRefusing to apply. Run "octo validate" to see why each of these is being destroyed, ' +
+        'then re-run with --auto-approve to proceed.'));
+    return true;
+}
+/**
+ * Step 3 of the octo lifecycle, and the only one that changes live infrastructure.
+ *
+ * Unlike generate and validate, this is a terraform action rather than an octo mode - it composes no
+ * model graph and reads no model or resource state. What it does need is the state provider, both
+ * because terraform's own state is checked out of it before every terraform command and back in
+ * after, and because this is one of the two commands that require the app lock. It refuses to run
+ * when the plan would destroy anything, unless `--auto-approve` is passed.
+ */
+export const applyCommand = {
+    builder: (yargs) => {
+        return yargs
+            .option('terragruntDir', {
+            demandOption: true,
+            description: 'The generated Terragrunt directory to apply.',
+            type: 'string',
+        })
+            .option('lockId', {
+            demandOption: true,
+            description: 'The app lock ID from `octo lock`. Applying without the lock is refused.',
+            type: 'string',
+        })
+            .option('autoApprove', {
+            default: false,
+            demandOption: false,
+            description: 'Apply without first checking the plan for destroys. Required to destroy anything.',
+            type: 'boolean',
+        })
+            .option('terraformBinary', {
+            demandOption: false,
+            description: 'Override the terraform/tofu binary terragrunt should invoke (sets TG_TF_PATH).',
+            type: 'string',
+        })
+            .option('terragruntBinary', {
+            demandOption: false,
+            description: 'Override the terragrunt binary/path to invoke.',
+            type: 'string',
+        })
+            .option('timeoutInMs', {
+            demandOption: false,
+            description: 'Override the per-command timeout, in milliseconds.',
+            type: 'number',
+        });
+    },
+    command: 'apply',
+    describe: 'Step 3: apply the generated Terraform in the Terragrunt directory.',
+    handler: async (argv) => {
+        const { autoApprove, lockId, terraformBinary, terragruntBinary, terragruntDir, timeoutInMs } = argv;
+        const resolvedDir = resolve(process.cwd(), terragruntDir);
+        prepareCallbackEnvironment();
+        try {
+            await bootStateProvider();
+            // The lock is verified before anything is planned, so a run without it fails having done
+            // nothing. It is released by `octo commit`, not here - the apply is the middle of a run.
+            const stateManagementService = await Container.getInstance().get(StateManagementService);
+            if (!(await stateManagementService.isAppLocked(lockId))) {
+                throw new Error('App is not locked! Run "octo lock" first.');
+            }
+            const terraformUtility = await Container.getInstance().get(TerraformUtility, {
+                args: [{ terraformBinary, terragruntBinary, timeoutInMs }, true],
+            });
+            // The underlying apply runs `-auto-approve` and validate is optional, so without an explicit
+            // opt-in, plan first and refuse to destroy anything the user has not been shown. What is at
+            // stake is the data inside a resource terraform recreates; octo's own state stays consistent
+            // either way.
+            if (!autoApprove && (await isBlockedByDestroys(terraformUtility, resolvedDir))) {
+                process.exit(1);
+            }
+            else {
+                // Streamed, not printed at the end: an ECS apply runs for tens of minutes, and terragrunt's
+                // own progress is the only sign it is alive. `apply` boots no octo and so has no listeners,
+                // which makes this the only writer here - nothing to interleave with.
+                try {
+                    await terraformUtility.apply(resolvedDir, {
+                        onOutput: (chunk, stream) => {
+                            if (stream === 'stdout') {
+                                process.stdout.write(chunk);
+                            }
+                            else {
+                                process.stderr.write(chunk);
+                            }
+                        },
+                    });
+                }
+                catch (error) {
+                    // An apply that got this far may have built some of what was asked for, and only a commit
+                    // records that. The rule belongs here rather than in every pipeline that calls this: the
+                    // apply is what knows it failed, and it is the one step after which the choice is not
+                    // obvious.
+                    console.error(chalk.red(`\nThis apply may have built part of what you asked for. Run "octo commit --partial ` +
+                        `--terragruntDir ${terragruntDir} --lockId ${lockId}" to record that and release the lock, then fix ` +
+                        'what failed and run again.'));
+                    throw error;
+                }
+                console.log(chalk.green('==== Apply complete ===='));
+            }
+        }
+        catch (error) {
+            reportError(error);
+            process.exit(1);
+        }
+    },
+};
+//# sourceMappingURL=apply.command.js.map

package/dist/commands/apply/apply.command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply.command.js","sourceRoot":"","sources":["../../../src/commands/apply/apply.command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,iBAAiB,EAAE,0BAA0B,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAWlH;;;;;GAKG;AACH,KAAK,UAAU,mBAAmB,CAAC,gBAAkC,EAAE,WAAmB;IACxF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnF,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACpB,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,QAAQ,gCAAgC,KAAK,EAAE,CAAC,CAAC,CAAC;QACtF,CAAC;QAED,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,GAAG,CACP,mFAAmF;YACjF,mDAAmD,CACtD,CACF,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,QAAQ,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC7D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAEtD,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAClF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,OAAO,KAAK,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,GAAG,CACP,wFAAwF;QACtF,6CAA6C,CAChD,CACF,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,CAAC,KAAW,EAAQ,EAAE;QAC7B,OAAO,KAAK;aACT,MAAM,CAAC,eAAe,EAAE;YACvB,YAAY,EAAE,IAAI;YAClB,WAAW,EAAE,8CAA8C;YAC3D,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,QAAQ,EAAE;YAChB,YAAY,EAAE,IAAI;YAClB,WAAW,EAAE,yEAAyE;YACtF,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,aAAa,EAAE;YACrB,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,KAAK;YACnB,WAAW,EAAE,mFAAmF;YAChG,IAAI,EAAE,SAAS;SAChB,CAAC;aACD,MAAM,CAAC,iBAAiB,EAAE;YACzB,YAAY,EAAE,KAAK;YACnB,WAAW,EAAE,gFAAgF;YAC7F,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,kBAAkB,EAAE;YAC1B,YAAY,EAAE,KAAK;YACnB,WAAW,EAAE,gDAAgD;YAC7D,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,aAAa,EAAE;YACrB,YAAY,EAAE,KAAK;YACnB,WAAW,EAAE,oDAAoD;YACjE,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;IACP,CAAC;IACD,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,oEAAoE;IAC9E,OAAO,EAAE,KAAK,EAAE,IAA+C,EAAiB,EAAE;QAChF,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QACpG,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;QAE1D,0BAA0B,EAAE,CAAC;QAE7B,IAAI,CAAC;YACH,MAAM,iBAAiB,EAAE,CAAC;YAE1B,yFAAyF;YACzF,yFAAyF;YACzF,MAAM,sBAAsB,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YACzF,IAAI,CAAC,CAAC,MAAM,sBAAsB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBACxD,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAC/D,CAAC;YAED,MAAM,gBAAgB,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC,GAAG,CAAwB,gBAAgB,EAAE;gBAClG,IAAI,EAAE,CAAC,EAAE,eAAe,EAAE,gBAAgB,EAAE,WAAW,EAAE,EAAE,IAAI,CAAC;aACjE,CAAC,CAAC;YAEH,6FAA6F;YAC7F,4FAA4F;YAC5F,6FAA6F;YAC7F,cAAc;YACd,IAAI,CAAC,WAAW,IAAI,CAAC,MAAM,mBAAmB,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC;gBAC/E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;iBAAM,CAAC;gBACN,4FAA4F;gBAC5F,4FAA4F;gBAC5F,sEAAsE;gBACtE,IAAI,CAAC;oBACH,MAAM,gBAAgB,CAAC,KAAK,CAAC,WAAW,EAAE;wBACxC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAQ,EAAE;4BAChC,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;gCACxB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;4BAC9B,CAAC;iCAAM,CAAC;gCACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;4BAC9B,CAAC;wBACH,CAAC;qBACF,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,0FAA0F;oBAC1F,yFAAyF;oBACzF,sFAAsF;oBACtF,WAAW;oBACX,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,GAAG,CACP,qFAAqF;wBACnF,mBAAmB,aAAa,aAAa,MAAM,kDAAkD;wBACrG,4BAA4B,CAC/B,CACF,CAAC;oBACF,MAAM,KAAK,CAAC;gBACd,CAAC;gBAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,WAAW,CAAC,KAAK,CAAC,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;CACF,CAAC"}

package/dist/commands/apply/index.d.ts

@@ -0,0 +1 @@
+export { applyCommand } from './apply.command.js';

package/dist/commands/apply/index.js

@@ -0,0 +1,2 @@
+export { applyCommand } from './apply.command.js';
+//# sourceMappingURL=index.js.map

package/dist/commands/apply/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/apply/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/commands/build/build.command.d.ts

@@ -5,10 +5,10 @@ export declare const buildCommand: {
     describe: string;
     handler: (argv: ArgumentsCamelCase<{
         buildFilePath: string;
-        sourcePath: string;
         concurrency: number;
         dryRun: boolean;
         logsDir: string;
+        sourcePath: string;
         timeout: number;
     }>) => Promise<void>;
 };

package/dist/commands/build/build.command.js

@@ -59,7 +59,7 @@ export const buildCommand = {
         logsDir = !logsDir || logsDir.toLowerCase() === 'false' ? undefined : resolve(logsDir);
         // Ensure build file exists.
         if (!existsSync(buildFilePath)) {
-            console.log(chalk.red('Cannot find build file: ' + buildFilePath));
+            console.error(chalk.red('Cannot find build file: ' + buildFilePath));
             process.exit(1);
         }
         // Ensure logsDir exists, and is writable.
@@ -69,7 +69,7 @@ export const buildCommand = {
             }
         }
         catch (error) {
-            console.log(chalk.red("Logs directory doesn't exist, or is not writable: " + logsDir));
+            console.error(chalk.red("Logs directory doesn't exist, or is not writable: " + logsDir));
             process.exit(1);
         }
         // Prepare args.
@@ -87,7 +87,7 @@ export const buildCommand = {
             json = load(readFileSync(buildFilePath, 'utf-8'));
         }
         catch (error) {
-            console.log(chalk.red('Unable to parse build file: ' + error.message));
+            console.error(chalk.red('Unable to parse build file: ' + error.message));
             throw error;
         }
         const buildConfiguration = BuildFileParser.parse(json);
@@ -97,7 +97,7 @@ export const buildCommand = {
             console.log(chalk.green('Success'));
         }
         catch (error) {
-            console.log(chalk.red(error));
+            console.error(chalk.red(error));
         }
     },
 };

package/dist/commands/build/build.command.js.map

@@ -1 +1 @@
-{"version":3,"file":"build.command.js","sourceRoot":"","sources":["../../../src/commands/build/build.command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEjE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,CAAC,KAAW,EAAQ,EAAE;QAC7B,OAAO,KAAK;aACT,MAAM,CAAC,eAAe,EAAE;YACvB,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,WAAW;YACpB,WAAW,EAAE,gDAAgD;YAC7D,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,YAAY,EAAE;YACpB,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,GAAG;YACZ,WAAW,EAAE,uCAAuC;YACpD,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,aAAa,EAAE;YACrB,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,uCAAuC;YACpD,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,QAAQ,EAAE;YAChB,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,8DAA8D;YAC3E,IAAI,EAAE,SAAS;SAChB,CAAC;aACD,MAAM,CAAC,SAAS,EAAE;YACjB,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,2DAA2D;YACxE,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,SAAS,EAAE;YACjB,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,uEAAuE;YACpF,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;IACP,CAAC;IACD,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,yCAAyC;IACnD,OAAO,EAAE,KAAK,EACZ,IAOE,EACa,EAAE;QACjB,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACzC,IAAI,OAAO,GAAuB,IAAI,CAAC,OAAO,CAAC;QAC/C,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAE9C,sBAAsB;QACtB,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC9D,CAAC;QACD,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAClC,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC;QACD,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;QACzD,OAAO,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEvF,4BAA4B;QAC5B,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,0BAA0B,GAAG,aAAa,CAAC,CAAC,CAAC;YACnE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,0CAA0C;QAC1C,IAAI,CAAC;YACH,IAAI,OAAO,EAAE,CAAC;gBACZ,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,oDAAoD,GAAG,OAAO,CAAC,CAAC,CAAC;YACvF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,gBAAgB;QAChB,MAAM,IAAI,GAAkB;YAC1B,aAAa;YACb,WAAW;YACX,MAAM;YACN,OAAO;YACP,UAAU;YACV,OAAO;SACR,CAAC;QAEF,+CAA+C;QAC/C,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;QACpD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,8BAA8B,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YACvE,MAAM,KAAK,CAAC;QACd,CAAC;QACD,MAAM,kBAAkB,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEvD,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;YAChD,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;CACF,CAAC"}
+{"version":3,"file":"build.command.js","sourceRoot":"","sources":["../../../src/commands/build/build.command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEjE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,CAAC,KAAW,EAAQ,EAAE;QAC7B,OAAO,KAAK;aACT,MAAM,CAAC,eAAe,EAAE;YACvB,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,WAAW;YACpB,WAAW,EAAE,gDAAgD;YAC7D,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,YAAY,EAAE;YACpB,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,GAAG;YACZ,WAAW,EAAE,uCAAuC;YACpD,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,aAAa,EAAE;YACrB,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,uCAAuC;YACpD,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,QAAQ,EAAE;YAChB,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,8DAA8D;YAC3E,IAAI,EAAE,SAAS;SAChB,CAAC;aACD,MAAM,CAAC,SAAS,EAAE;YACjB,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,2DAA2D;YACxE,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,SAAS,EAAE;YACjB,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,uEAAuE;YACpF,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;IACP,CAAC;IACD,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,yCAAyC;IACnD,OAAO,EAAE,KAAK,EACZ,IAOE,EACa,EAAE;QACjB,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACzC,IAAI,OAAO,GAAuB,IAAI,CAAC,OAAO,CAAC;QAC/C,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAE9C,sBAAsB;QACtB,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC9D,CAAC;QACD,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAClC,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC;QACD,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;QACzD,OAAO,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEvF,4BAA4B;QAC5B,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,0BAA0B,GAAG,aAAa,CAAC,CAAC,CAAC;YACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,0CAA0C;QAC1C,IAAI,CAAC;YACH,IAAI,OAAO,EAAE,CAAC;gBACZ,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,oDAAoD,GAAG,OAAO,CAAC,CAAC,CAAC;YACzF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,gBAAgB;QAChB,MAAM,IAAI,GAAkB;YAC1B,aAAa;YACb,WAAW;YACX,MAAM;YACN,OAAO;YACP,UAAU;YACV,OAAO;SACR,CAAC;QAEF,+CAA+C;QAC/C,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;QACpD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,8BAA8B,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YACzE,MAAM,KAAK,CAAC;QACd,CAAC;QACD,MAAM,kBAAkB,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEvD,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;YAChD,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;CACF,CAAC"}

package/dist/commands/build/main.d.ts

@@ -1,16 +1,38 @@
 import type { ChildProcessWithoutNullStreams } from 'child_process';
 import type { IBuildConfiguration } from './models/build-configuration.interface.js';
 import type { IRunArguments } from './models/run-arguments.interface.js';
+/**
+ * @internal
+ */
+/**
+ * Runs the jobs of a `build.yml`, respecting their dependencies and the concurrency limit.
+ */
 export declare class Main {
     private readonly args;
     private readonly configuration;
+    /**
+     * @param args The parsed CLI arguments.
+     * @param configuration The parsed build file.
+     */
     constructor(args: IRunArguments, configuration: IBuildConfiguration);
+    /**
+     * Spawns one command.
+     *
+     * @returns The child process, and a promise that settles when it exits - rejecting on a non-zero
+     * exit code.
+     */
     runCommand(command: string, options: {
         env: {
             [key: string]: string;
         };
         sourcePath: string;
     }): [ChildProcessWithoutNullStreams, Promise<void>];
+    /**
+     * Starts every job, each waiting on the jobs it depends on, and no more than `concurrency` at once.
+     */
     scheduleJobs(): Promise<void>[];
+    /**
+     * Runs the whole build, rejecting on the first job that fails or when the timeout elapses.
+     */
     start(): Promise<void>;
 }

package/dist/commands/build/main.js

@@ -3,11 +3,27 @@ import { join, resolve } from 'path';
 import pLimit from 'p-limit';
 import { ProcessUtility } from '../../utilities/process/process.utility.js';
 import { StreamManager } from './streams/stream-manager.js';
+/**
+ * @internal
+ */
+/**
+ * Runs the jobs of a `build.yml`, respecting their dependencies and the concurrency limit.
+ */
 export class Main {
+    /**
+     * @param args The parsed CLI arguments.
+     * @param configuration The parsed build file.
+     */
     constructor(args, configuration) {
         this.args = args;
         this.configuration = configuration;
     }
+    /**
+     * Spawns one command.
+     *
+     * @returns The child process, and a promise that settles when it exits - rejecting on a non-zero
+     * exit code.
+     */
     runCommand(command, options) {
         const spawnProcessOptions = { cwd: options.sourcePath, env: options.env, shell: true };
         const runner = ProcessUtility.runDetachedProcess(command, spawnProcessOptions, 'pipe');
@@ -33,6 +49,9 @@ export class Main {
         });
         return [runner, promiseToFinishCommand];
     }
+    /**
+     * Starts every job, each waiting on the jobs it depends on, and no more than `concurrency` at once.
+     */
     scheduleJobs() {
         const streamManager = new StreamManager();
         const timestamp = Date.now();
@@ -102,6 +121,9 @@ export class Main {
         }
         return Object.values(jobPromises);
     }
+    /**
+     * Runs the whole build, rejecting on the first job that fails or when the timeout elapses.
+     */
     start() {
         return new Promise(async (resolve, reject) => {
             const timeout = this.args.timeout > 0

package/dist/commands/build/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../../../src/commands/build/main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,MAAM,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAC;AAG5E,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,MAAM,OAAO,IAAI;IACf,YACmB,IAAmB,EACnB,aAAkC;QADlC,SAAI,GAAJ,IAAI,CAAe;QACnB,kBAAa,GAAb,aAAa,CAAqB;IAClD,CAAC;IAEJ,UAAU,CACR,OAAe,EACf,OAA+D;QAE/D,MAAM,mBAAmB,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,UAAU,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACvF,MAAM,MAAM,GAAG,cAAc,CAAC,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;QAEvF,MAAM,sBAAsB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACd,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;gBAC9B,MAAM,CAAC,kBAAkB,EAAE,CAAC;gBAE5B,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;oBACnB,OAAO,EAAE,CAAC;gBACZ,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;oBAChE,KAAK,CAAC,MAAM,CAAC,GAAG;wBACd,OAAO;wBACP,QAAQ;qBACT,CAAC;oBACF,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,YAAY;QACV,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,0CAA0C;QAC1C,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxG,IAAI,cAAc,EAAE,CAAC;YACnB,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC;QACnC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,WAAW,GAAqC,EAAE,CAAC;QACzD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAE5C,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,OAAO,aAAa,KAAK,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;YAC9D,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;gBAC9B,IAAI,OAAO,IAAI,WAAW,EAAE,CAAC;oBAC3B,SAAS;gBACX,CAAC;gBAED,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAE7C,IAAI,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,WAAW,CAAC,EAAE,CAAC;oBACjD,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK,CAC1B,GAAG,EAAE,CACH,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;wBACpC,IAAI,CAAC;4BACH,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBAC9D,CAAC;wBAAC,OAAO,KAAK,EAAE,CAAC;4BACf,MAAM,CAAC,KAAK,CAAC,CAAC;4BACd,OAAO;wBACT,CAAC;wBAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;4BACpC,MAAM,OAAO,GACX,GAAG,CAAC,OAAO,GAAG,CAAC;gCACb,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE;oCACd,GAAG,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;gCACvF,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;gCACjB,CAAC,CAAC,SAAS,CAAC;4BAEhB,IAAI,CAAC;gCACH,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;oCACtB,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE;wCACpE,GAAG;wCACH,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;qCACjC,CAAC,CAAC;oCACH,aAAa,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;oCAClE,MAAM,sBAAsB,CAAC;gCAC/B,CAAC;gCAED,OAAO,EAAE,CAAC;gCACV,MAAM;4BACR,CAAC;4BAAC,OAAO,KAAK,EAAE,CAAC;gCACf,IAAI,CAAC,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC;oCACpB,GAAG,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;gCACtD,CAAC;4BACH,CAAC;oCAAS,CAAC;gCACT,IAAI,OAAO,EAAE,CAAC;oCACZ,YAAY,CAAC,OAAO,CAAC,CAAC;gCACxB,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC,CAAC,CACL,CAAC;oBAEF,aAAa,IAAI,CAAC,CAAC;gBACrB,CAAC;YACH,CAAC;YAED,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;QAED,IAAI,aAAa,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACpC,CAAC;IAED,KAAK;QACH,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,MAAM,OAAO,GACX,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC;gBACnB,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE;oBACd,MAAM,CAAC,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC;gBACnE,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;gBACvB,CAAC,CAAC,SAAS,CAAC;YAEhB,IAAI,CAAC;gBACH,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;gBACxC,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBAC/B,OAAO,EAAE,CAAC;YACZ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC;oBAAS,CAAC;gBACT,IAAI,OAAO,EAAE,CAAC;oBACZ,YAAY,CAAC,OAAO,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../../src/commands/build/main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,MAAM,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAC;AAG5E,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D;;GAEG;AACH;;GAEG;AACH,MAAM,OAAO,IAAI;IACf;;;OAGG;IACH,YACmB,IAAmB,EACnB,aAAkC;QADlC,SAAI,GAAJ,IAAI,CAAe;QACnB,kBAAa,GAAb,aAAa,CAAqB;IAClD,CAAC;IAEJ;;;;;OAKG;IACH,UAAU,CACR,OAAe,EACf,OAA+D;QAE/D,MAAM,mBAAmB,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,UAAU,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACvF,MAAM,MAAM,GAAG,cAAc,CAAC,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;QAEvF,MAAM,sBAAsB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACd,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;gBAC9B,MAAM,CAAC,kBAAkB,EAAE,CAAC;gBAE5B,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;oBACnB,OAAO,EAAE,CAAC;gBACZ,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;oBAChE,KAAK,CAAC,MAAM,CAAC,GAAG;wBACd,OAAO;wBACP,QAAQ;qBACT,CAAC;oBACF,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,YAAY;QACV,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,0CAA0C;QAC1C,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxG,IAAI,cAAc,EAAE,CAAC;YACnB,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC;QACnC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,WAAW,GAAqC,EAAE,CAAC;QACzD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAE5C,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,OAAO,aAAa,KAAK,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;YAC9D,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;gBAC9B,IAAI,OAAO,IAAI,WAAW,EAAE,CAAC;oBAC3B,SAAS;gBACX,CAAC;gBAED,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAE7C,IAAI,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,WAAW,CAAC,EAAE,CAAC;oBACjD,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK,CAC1B,GAAG,EAAE,CACH,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;wBACpC,IAAI,CAAC;4BACH,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBAC9D,CAAC;wBAAC,OAAO,KAAK,EAAE,CAAC;4BACf,MAAM,CAAC,KAAK,CAAC,CAAC;4BACd,OAAO;wBACT,CAAC;wBAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;4BACpC,MAAM,OAAO,GACX,GAAG,CAAC,OAAO,GAAG,CAAC;gCACb,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE;oCACd,GAAG,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;gCACvF,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;gCACjB,CAAC,CAAC,SAAS,CAAC;4BAEhB,IAAI,CAAC;gCACH,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;oCACtB,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE;wCACpE,GAAG;wCACH,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;qCACjC,CAAC,CAAC;oCACH,aAAa,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;oCAClE,MAAM,sBAAsB,CAAC;gCAC/B,CAAC;gCAED,OAAO,EAAE,CAAC;gCACV,MAAM;4BACR,CAAC;4BAAC,OAAO,KAAK,EAAE,CAAC;gCACf,IAAI,CAAC,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC;oCACpB,GAAG,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;gCACtD,CAAC;4BACH,CAAC;oCAAS,CAAC;gCACT,IAAI,OAAO,EAAE,CAAC;oCACZ,YAAY,CAAC,OAAO,CAAC,CAAC;gCACxB,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC,CAAC,CACL,CAAC;oBAEF,aAAa,IAAI,CAAC,CAAC;gBACrB,CAAC;YACH,CAAC;YAED,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;QAED,IAAI,aAAa,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,MAAM,OAAO,GACX,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC;gBACnB,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE;oBACd,MAAM,CAAC,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC;gBACnE,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;gBACvB,CAAC,CAAC,SAAS,CAAC;YAEhB,IAAI,CAAC;gBACH,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;gBACxC,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBAC/B,OAAO,EAAE,CAAC;YACZ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC;oBAAS,CAAC;gBACT,IAAI,OAAO,EAAE,CAAC;oBACZ,YAAY,CAAC,OAAO,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/commands/build/parsers/build-file.parser.d.ts

@@ -1,4 +1,10 @@
 import type { IBuildConfiguration } from '../models/build-configuration.interface.js';
+/**
+ * Reads a `build.yml` into the configuration {@link Main} runs.
+ */
 export declare class BuildFileParser {
+    /**
+     * @throws If a job names a dependency that does not exist, or the jobs form a cycle.
+     */
     static parse(content: any): IBuildConfiguration;
 }

package/dist/commands/build/parsers/build-file.parser.js

@@ -1,4 +1,10 @@
+/**
+ * Reads a `build.yml` into the configuration {@link Main} runs.
+ */
 export class BuildFileParser {
+    /**
+     * @throws If a job names a dependency that does not exist, or the jobs form a cycle.
+     */
     static parse(content) {
         const jobs = {};
         for (const jobName of Object.keys(content?.jobs || {})) {

package/dist/commands/build/parsers/build-file.parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"build-file.parser.js","sourceRoot":"","sources":["../../../../src/commands/build/parsers/build-file.parser.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,eAAe;IAC1B,MAAM,CAAC,KAAK,CAAC,OAAY;QACvB,MAAM,IAAI,GAA4B,EAAE,CAAC;QACzC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;YACvD,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAChE,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,GAAG;gBACd,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,EAAE;gBAC9B,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,OAAO;gBAC9C,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC7B,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;aAClC,CAAC;QACJ,CAAC;QAED,OAAO;YACL,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE;YACzB,GAAG,EACD,OAAO,EAAE,GAAG,EAAE,SAAS;gBACvB,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,QAAQ;gBACzC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC;gBAC3C,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS;gBACvB,CAAC,CAAC,EAAE;YACR,IAAI;SACL,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"build-file.parser.js","sourceRoot":"","sources":["../../../../src/commands/build/parsers/build-file.parser.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,eAAe;IAC1B;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,OAAY;QACvB,MAAM,IAAI,GAA4B,EAAE,CAAC;QACzC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;YACvD,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAChE,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,GAAG;gBACd,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,EAAE;gBAC9B,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,OAAO;gBAC9C,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC7B,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;aAClC,CAAC;QACJ,CAAC;QAED,OAAO;YACL,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE;YACzB,GAAG,EACD,OAAO,EAAE,GAAG,EAAE,SAAS;gBACvB,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,QAAQ;gBACzC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC;gBAC3C,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS;gBACvB,CAAC,CAAC,EAAE;YACR,IAAI;SACL,CAAC;IACJ,CAAC;CACF"}

package/dist/commands/build/streams/stream-manager.d.ts

@@ -1,6 +1,12 @@
 import type { ChildProcessWithoutNullStreams } from 'child_process';
+/**
+ * Fans each job's output to the terminal, and to a per-job log file when one was asked for.
+ */
 export declare class StreamManager {
     private colors;
+    /**
+     * Attaches to a running job's output.
+     */
     registerStream(jobName: string, stream: ChildProcessWithoutNullStreams, options: {
         logsPathPrefix?: string;
     }): void;

package/dist/commands/build/streams/stream-manager.js

@@ -1,6 +1,9 @@
 import { createWriteStream } from 'fs';
 import { join, resolve } from 'path';
 import chalk, {} from 'chalk';
+/**
+ * Fans each job's output to the terminal, and to a per-job log file when one was asked for.
+ */
 export class StreamManager {
     constructor() {
         this.colors = {
@@ -11,6 +14,9 @@ export class StreamManager {
             YELLOW: chalk.yellow,
         };
     }
+    /**
+     * Attaches to a running job's output.
+     */
     registerStream(jobName, stream, options) {
         const colorKeys = Object.keys(this.colors);
         const randomColor = this.colors[colorKeys[(colorKeys.length * Math.random()) << 0]];
@@ -18,7 +24,7 @@ export class StreamManager {
             console.log(randomColor(data.toString()));
         });
         stream.stderr.on('error', (error) => {
-            console.log(chalk.red(error));
+            console.error(chalk.red(error));
         });
         stream.on('close', () => {
             stream.removeAllListeners();

package/dist/commands/build/streams/stream-manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"stream-manager.js","sourceRoot":"","sources":["../../../../src/commands/build/streams/stream-manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,IAAI,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,KAAK,EAAE,EAAsB,MAAM,OAAO,CAAC;AAElD,MAAM,OAAO,aAAa;IAA1B;QACU,WAAM,GAAG;YACf,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;SACrB,CAAC;IAwBJ,CAAC;IAtBC,cAAc,CAAC,OAAe,EAAE,MAAsC,EAAE,OAAoC;QAC1G,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,WAAW,GAAkB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEnG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAChC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAClC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,MAAM,CAAC,kBAAkB,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,MAAM,WAAW,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,OAAO,MAAM,CAAC,CAAC,EAAE;gBAC7F,KAAK,EAAE,GAAG;aACX,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAChC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"stream-manager.js","sourceRoot":"","sources":["../../../../src/commands/build/streams/stream-manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,IAAI,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,KAAK,EAAE,EAAsB,MAAM,OAAO,CAAC;AAElD;;GAEG;AACH,MAAM,OAAO,aAAa;IAA1B;QACU,WAAM,GAAG;YACf,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,MAAM,EAAE,KAAK,CAAC,MAAM;SACrB,CAAC;IA2BJ,CAAC;IAzBC;;OAEG;IACH,cAAc,CAAC,OAAe,EAAE,MAAsC,EAAE,OAAoC;QAC1G,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,WAAW,GAAkB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEnG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAChC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAClC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,MAAM,CAAC,kBAAkB,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,MAAM,WAAW,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,OAAO,MAAM,CAAC,CAAC,EAAE;gBAC7F,KAAK,EAAE,GAAG;aACX,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAChC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;CACF"}

package/dist/commands/commit/commit.command.d.ts

@@ -0,0 +1,22 @@
+import type { ArgumentsCamelCase, Argv } from 'yargs';
+type CommitCommandArguments = {
+    lockId: string;
+    partial?: boolean;
+    terraformBinary?: string;
+    terragruntBinary?: string;
+    terragruntDir: string;
+    timeoutInMs?: number;
+};
+/**
+ * Step 4 of the octo lifecycle. See {@link Octo.commit}.
+ *
+ * This is the command that ends a run, so it is the one that releases the app lock - however the
+ * commit itself finishes. Octo never unlocks on its own; the lock is the CLI's to take and to drop.
+ */
+export declare const commitCommand: {
+    builder: (yargs: Argv) => Argv;
+    command: string;
+    describe: string;
+    handler: (argv: ArgumentsCamelCase<CommitCommandArguments>) => Promise<void>;
+};
+export {};

package/dist/commands/commit/commit.command.js

@@ -0,0 +1,94 @@
+import { resolve } from 'path';
+import { Container, StateManagementService, TerraformUtility } from '@quadnix/octo';
+import chalk from 'chalk';
+import { bootOcto, bootStateProvider, reportError } from '../../utilities/octo/octo.utility.js';
+/**
+ * Step 4 of the octo lifecycle. See {@link Octo.commit}.
+ *
+ * This is the command that ends a run, so it is the one that releases the app lock - however the
+ * commit itself finishes. Octo never unlocks on its own; the lock is the CLI's to take and to drop.
+ */
+export const commitCommand = {
+    builder: (yargs) => {
+        return yargs
+            .option('terragruntDir', {
+            demandOption: true,
+            description: 'The generated Terragrunt directory, post apply (`terragrunt run-all apply`).',
+            type: 'string',
+        })
+            .option('lockId', {
+            demandOption: true,
+            description: 'The app lock ID from `octo lock`. Released when this command finishes.',
+            type: 'string',
+        })
+            .option('partial', {
+            default: false,
+            demandOption: false,
+            description: 'Record what did apply, leaving resources with missing outputs uncommitted. For a failed apply.',
+            type: 'boolean',
+        })
+            .option('terraformBinary', {
+            demandOption: false,
+            description: 'Override the terraform/tofu binary terragrunt should invoke (sets TG_TF_PATH).',
+            type: 'string',
+        })
+            .option('terragruntBinary', {
+            demandOption: false,
+            description: 'Override the terragrunt binary/path to invoke.',
+            type: 'string',
+        })
+            .option('timeoutInMs', {
+            demandOption: false,
+            description: 'Override the per-command timeout, in milliseconds.',
+            type: 'number',
+        });
+    },
+    command: 'commit',
+    describe: "Step 4: record the results of a Terraform apply back into Octo's state.",
+    handler: async (argv) => {
+        const { lockId, partial, terraformBinary, terragruntBinary, terragruntDir, timeoutInMs } = argv;
+        const resolvedDir = resolve(process.cwd(), terragruntDir);
+        try {
+            // The state provider is resolved before anything else, so the lock can be released even when
+            // the boot below is what fails. Booting octo replaces this service with one built on its own
+            // provider; both are the same store, so either releases the same lock.
+            await bootStateProvider();
+            const stateManagementService = await Container.getInstance().get(StateManagementService);
+            // This command ends a run, so it releases the lock no matter how the run turns out - a failed
+            // commit has left octo state untouched, and holding the lock afterwards would only block the
+            // re-run that fixes it.
+            try {
+                const { app, octo } = await bootOcto();
+                const terraformUtility = await Container.getInstance().get(TerraformUtility, {
+                    args: [{ terraformBinary, terragruntBinary, timeoutInMs }, true],
+                });
+                // Read outputs from every folder terragrunt discovers. A folder whose outputs cannot be read
+                // is warned and omitted rather than aborting the commit: octo rejects the commit itself if
+                // that folder held a module it tracks, and merely warns if it is a folder octo does not know.
+                const [outputs, moduleIds] = await Promise.all([
+                    terraformUtility.output(resolvedDir, { json: true }),
+                    terraformUtility.listModuleFolders(resolvedDir),
+                ]);
+                for (const moduleId of moduleIds) {
+                    if (!outputs.has(moduleId)) {
+                        console.error(chalk.yellow(`WARN [${moduleId}] Could not read terraform outputs`));
+                    }
+                }
+                const { warnings } = await octo.commit(app, { lockId, outputs, partial });
+                for (const warning of warnings) {
+                    console.error(chalk.yellow(`WARN ${warning.moduleId ? `[${warning.moduleId}] ` : ''}${warning.message}`));
+                }
+                // No verdict printed here - the listeners own stdout and render the commit report there.
+                // The warnings above stay, on stderr: a different fd, so they cannot interleave with pino.
+            }
+            finally {
+                await stateManagementService.unlockApp(lockId);
+            }
+        }
+        catch (error) {
+            reportError(error);
+            process.exit(1);
+        }
+    },
+};
+//# sourceMappingURL=commit.command.js.map

package/dist/commands/commit/commit.command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commit.command.js","sourceRoot":"","sources":["../../../src/commands/commit/commit.command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAWhG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,CAAC,KAAW,EAAQ,EAAE;QAC7B,OAAO,KAAK;aACT,MAAM,CAAC,eAAe,EAAE;YACvB,YAAY,EAAE,IAAI;YAClB,WAAW,EAAE,8EAA8E;YAC3F,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,QAAQ,EAAE;YAChB,YAAY,EAAE,IAAI;YAClB,WAAW,EAAE,wEAAwE;YACrF,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,SAAS,EAAE;YACjB,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,KAAK;YACnB,WAAW,EAAE,gGAAgG;YAC7G,IAAI,EAAE,SAAS;SAChB,CAAC;aACD,MAAM,CAAC,iBAAiB,EAAE;YACzB,YAAY,EAAE,KAAK;YACnB,WAAW,EAAE,gFAAgF;YAC7F,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,kBAAkB,EAAE;YAC1B,YAAY,EAAE,KAAK;YACnB,WAAW,EAAE,gDAAgD;YAC7D,IAAI,EAAE,QAAQ;SACf,CAAC;aACD,MAAM,CAAC,aAAa,EAAE;YACrB,YAAY,EAAE,KAAK;YACnB,WAAW,EAAE,oDAAoD;YACjE,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;IACP,CAAC;IACD,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,yEAAyE;IACnF,OAAO,EAAE,KAAK,EAAE,IAAgD,EAAiB,EAAE;QACjF,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAChG,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;QAE1D,IAAI,CAAC;YACH,6FAA6F;YAC7F,6FAA6F;YAC7F,uEAAuE;YACvE,MAAM,iBAAiB,EAAE,CAAC;YAC1B,MAAM,sBAAsB,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAEzF,8FAA8F;YAC9F,6FAA6F;YAC7F,wBAAwB;YACxB,IAAI,CAAC;gBACH,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,MAAM,QAAQ,EAAE,CAAC;gBACvC,MAAM,gBAAgB,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC,GAAG,CAAwB,gBAAgB,EAAE;oBAClG,IAAI,EAAE,CAAC,EAAE,eAAe,EAAE,gBAAgB,EAAE,WAAW,EAAE,EAAE,IAAI,CAAC;iBACjE,CAAC,CAAC;gBAEH,6FAA6F;gBAC7F,2FAA2F;gBAC3F,8FAA8F;gBAC9F,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;oBAC7C,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;oBACpD,gBAAgB,CAAC,iBAAiB,CAAC,WAAW,CAAC;iBAChD,CAAC,CAAC;gBACH,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;oBACjC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC3B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,QAAQ,oCAAoC,CAAC,CAAC,CAAC;oBACrF,CAAC;gBACH,CAAC;gBAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC1E,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;oBAC/B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBAC5G,CAAC;gBAED,yFAAyF;gBACzF,2FAA2F;YAC7F,CAAC;oBAAS,CAAC;gBACT,MAAM,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,WAAW,CAAC,KAAK,CAAC,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;CACF,CAAC"}

package/dist/commands/commit/index.d.ts

@@ -0,0 +1 @@
+export { commitCommand } from './commit.command.js';

package/dist/commands/commit/index.js

@@ -0,0 +1,2 @@
+export { commitCommand } from './commit.command.js';
+//# sourceMappingURL=index.js.map

package/dist/commands/commit/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/commit/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/commands/create-anchor/create-anchor.command.js

@@ -33,7 +33,7 @@ export const createAnchorCommand = {
             .option('path', {
             alias: 'p',
             default: '.',
-            description: 'Root directory path of the CDK.',
+            description: 'Root directory path of the project.',
             type: 'string',
         });
     },