@cloud-cli/on 1.2.2 → 1.2.4

package/README.md

@@ -54,9 +54,10 @@ Secrets are automatically loaded from `.env` at the root of your project. Prefix
 SECRET_NPM_TOKEN="npm_1234567890abcdef"
 SECRET_GITHUB_TOKEN="ghp_1234567890abcdef"
 SECRET_GITHUB_WEBHOOK_SECRET="my-webhook-secret"
-
 ```
 
+`SECRET_GITHUB_WEBHOOK_SECRET` is required to validate incoming webhooks from GitHub
+
 ### 3. Define a Workflow (`.on/release.yml`)
 
 ```yaml
@@ -106,23 +107,26 @@ npx @cloud-cli/on [command] [options]
 
 ### Commands
 
-| Command                 | Description                                                               |
-| ----------------------- | ------------------------------------------------------------------------- |
-| **`start`** _(default)_ | Runs both Webhook Ingress Gateway and Worker execution loops together.    |
-| **`start-server`**      | Runs Webhook Ingress Gateway only (API / Gateway mode).                   |
-| **`start-workers`**     | Runs Worker Polling loops only (Scalable Worker mode).                    |
-| **`validate`**          | Parses and validates all YAML workflows in `.on/` without executing jobs. |
+| Command                 | Description                                                                              |
+| ----------------------- | ---------------------------------------------------------------------------------------- |
+| **`start`** _(default)_ | Runs both Webhook Ingress Gateway and Worker execution loops together.                   |
+| **`start-server`**      | Runs Webhook Ingress Gateway only (API / Gateway mode).                                  |
+| **`start-workers`**     | Runs Worker Polling loops only (Scalable Worker mode).                                   |
+| **`validate`**          | Parses and validates all YAML workflows in your workflows folder without executing jobs. |
+
+### CLI and Environment Options
 
-### CLI Options
+| Flag | Option        | Default               | Env                   | Description                               |
+| ---- | ------------- | --------------------- | --------------------- | ----------------------------------------- |
+| `-h` | `--help`      | —                     | -                     | Prints CLI help message and exits.        |
+| `-c` | `--config`    | `./runner.config.mjs` | `RUNNER_CONFIG_FILE`  | Path to JavaScript configuration file.    |
+| `-d` | `--database`  | -                     | `RUNNER_DATABASE_URL` | SQLite database file path or HTTP URL.    |
+| `-w` | `--workflows` | `.on/`                | `RUNNER_WORKFLOWS`    | Directory where workflow YAML files live. |
+| `-p` | `--port`      | `11235`               | `PORT`                | Port for the Ingress HTTP server.         |
+| `-k` | `--workers`   | `5`                   | `RUNNER_WORKERS`      | Number of worker loop threads to spawn.   |
+|      |               |                       | `RUNNER_ADMIN_SECRET` | Admin token to refresh secrets via API    |
 
-| Flag | Option        | Default                    | Description                               |
-| ---- | ------------- | -------------------------- | ----------------------------------------- |
-| `-c` | `--config`    | `./runner.config.mjs`      | Path to JavaScript configuration file.    |
-| `-d` | `--database`  | `process.env.DATABASE_URL` | SQLite database file path or HTTP URL.    |
-| `-w` | `--workflows` | `.on/`                     | Directory where workflow YAML files live. |
-| `-p` | `--port`      | `3000`                     | Port for the Ingress HTTP server.         |
-| `-k` | `--workers`   | `5`                        | Number of worker loop threads to spawn.   |
-| `-h` | `--help`      | —                          | Prints CLI help message and exits.        |
+### Secrets
 
 ---
 
@@ -136,10 +140,10 @@ import { HtmlReporter, SlackReporter, JsonFileReporter } from '@cloud-cli/on/rep
 
 export default {
   port: 3000,
-  workersCount: 5,
-  workflowsDir: '.on/',
+  workers: 5,
+  workflows: '/home/workflows/',
   storagePath: '/tmp/workspaces',
-  sqliteUrl: 'sqlite.db',
+  database: 'https://remote.db.com/',
 
   // Global environment variables passed to all steps
   env: {
@@ -194,7 +198,7 @@ Within `${...}`, `if:`, and `eval:` contexts, the following object scopes are ex
 
 - **`inputs`**: Payload key-values received from incoming webhooks.
 - **`env`**: Merged environment variables from global config and workflow definitions.
-- **`secrets`**: Unmasked secret values loaded from `.env` (`SECRET_` prefix stripped).
+- **`secrets`**: Unmasked secret values loaded from `.env` or environment variables (`SECRET_` prefix stripped).
 - **`steps`**: Execution statuses and outputs from previous steps in the workflow (`steps.<id>.status`, `steps.<id>.outputs`).
 - **`BUILTIN_HELPERS`**: JS utilities including `String`, `Number`, `Boolean`, and `JSON.parse` / `JSON.stringify`.
 

package/dist/db-client.d.ts

@@ -0,0 +1,14 @@
+declare function query(method: 'get' | 'run' | 'all', statement: string, data?: Array<string | number | null>, pragma?: string[]): Promise<any>;
+export declare const get: (statement: string, data?: (string | number | null)[] | undefined, pragma?: string[] | undefined) => Promise<any>;
+export declare const run: (statement: string, data?: (string | number | null)[] | undefined, pragma?: string[] | undefined) => Promise<any>;
+export declare const all: (statement: string, data?: (string | number | null)[] | undefined, pragma?: string[] | undefined) => Promise<any>;
+export declare function pragma(p: any): void;
+declare const _default: {
+    query: typeof query;
+    get: (statement: string, data?: (string | number | null)[] | undefined, pragma?: string[] | undefined) => Promise<any>;
+    run: (statement: string, data?: (string | number | null)[] | undefined, pragma?: string[] | undefined) => Promise<any>;
+    all: (statement: string, data?: (string | number | null)[] | undefined, pragma?: string[] | undefined) => Promise<any>;
+    pragma: typeof pragma;
+};
+export default _default;
+export declare function setUrl(u: any): void;

package/dist/drivers/index.d.ts

@@ -0,0 +1,2 @@
+import { ExecutionDriver } from '../types.js';
+export declare function resolveDriver(): Promise<ExecutionDriver>;

package/dist/drivers/standard-process.driver.d.ts

@@ -0,0 +1,10 @@
+import { ExecutionDriver, StepContext, StepExecutionHandle } from '../types.js';
+export declare class StandardProcessDriver implements ExecutionDriver {
+    name: string;
+    isSupported(): Promise<boolean>;
+    execute(ctx: StepContext): Promise<StepExecutionHandle>;
+    /**
+     * Kills the entire process group tree (-PID) with unref escalation
+     */
+    private killProcessGroup;
+}

package/dist/drivers/systemd.driver.d.ts

@@ -0,0 +1,6 @@
+import { ExecutionDriver, StepContext, StepExecutionHandle } from '../types.js';
+export declare class SystemdDriver implements ExecutionDriver {
+    name: string;
+    isSupported(): Promise<boolean>;
+    execute(ctx: StepContext): Promise<StepExecutionHandle>;
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+export { HtmlReporter } from './reporters/html.reporter.js';
+export { JsonFileReporter } from './reporters/json-file.reporter.js';
+export { SlackReporter } from './reporters/slack.reporter.js';

package/dist/log-redactor.d.ts

@@ -0,0 +1,6 @@
+import { Transform, TransformCallback } from 'node:stream';
+export declare class SecretRedactorStream extends Transform {
+    private secretValues;
+    constructor(secretValues: string[]);
+    _transform(chunk: any, _encoding: BufferEncoding, callback: TransformCallback): void;
+}