@stringsync/splates 0.0.54 → 0.0.56

package/README.md

@@ -59,11 +59,10 @@ in `splates.config.ts` to move the directory, relative to the checkout root
 or to an absolute path. Notes change through tasks, just as code does.
 Keep sensitive information out of them.
 
-**Heavy jobs.** Hooks (`postCheckout`, `postRewrite`, `preMerge`) run in one
-of the machine's heavy-job slots, two by default (`SPLATES_HEAVY_JOBS` sets
-how many), so several agents testing at once queue rather than run the
-machine out of memory. `splates heavy -- <command>` runs anything else as
-heavy, such as a test suite an agent runs mid-task, in a slot too.
+**One premerge at a time.** Each merge's gate (`postRewrite` and
+`preMerge`) holds the machine's premerge lock, so merges from several agents
+test one after another rather than run the machine out of memory. A gate
+that runs past 3 minutes is killed, and the agent merges again.
 
 **Pushing.** With `remote: "origin"` in `splates.config.ts`, each task's
 branch goes to that remote as `splates/<task>`: after every commit an agent
@@ -251,75 +250,12 @@ traffic, and `--tunnel-name` is refused beside a provider of your own. One
 that is not ready, or fails to start, is logged and skipped: the page keeps
 serving on this machine.
 
-### Worker providers
+### Local worker
 
-To have splates make workers when agents queue for want of a slot, name the
-cloud account to make them in as `splates.config.ts`'s `cloud`, in the repo
-`splates server` starts in:
-
-```ts
-import { AwsCloud } from "@stringsync/splates-server/cloud";
-import type { ConfigFile } from "@stringsync/splates-server/config";
-
-export default { cloud: new AwsCloud() } satisfies ConfigFile;
-```
-
-`AwsCloud` comes with splates, signed with the AWS CLI's sign-in or the
-instance role. Another is a class that implements
-`CloudProvider` from `@stringsync/splates-server/cloud`: making, listing and
-deleting tagged machines, snapshots, SSH keys and firewalls through the
-cloud's API, with its machine types and prices. splates makes both the
-workers and the coordinator's box (`splates server deploy`) over it.
-
-For machines that are not a cloud's, give it a `workerProvider` instead, any
-object that implements `WorkerProvider`:
-
-```ts
-import type { ConfigFile } from "@stringsync/splates-server/config";
-import type { WorkerProvider } from "@stringsync/splates-server/workers";
-
-const myCloud: WorkerProvider = {
-	// the machines it makes, with what each costs you per hour
-	types: async () => [
-		{ name: "small", platform: "linux", slots: 4, dollarsPerHour: 0.05 },
-	],
-	// build an image by running recipe.script as root on a fresh machine
-	snapshot: async (recipe) => ({ id: "img-1", version: recipe.version, builtAt: Date.now() }),
-	// boot spec.snapshot and run spec.boot on it, as the `splates` user
-	create: async (spec) => ({ id: spec.id, type: spec.type }),
-	destroy: async (id) => {},
-	// the machines it made that still exist
-	list: async () => [],
-};
-
-export default { workerProvider: myCloud } satisfies ConfigFile;
-```
-
-A made worker boots from a snapshot splates asks for when there is none, and
-again when splates's version changes or the snapshot is a week old; it holds
-bun, git, the browser and splates, and no credentials. Its boot command spends
-a single-use join token, dialing the page at its tunnel host, so the server
-needs a tunnel. Placement makes one only once agents other agents started are
-queued, and only as far as the worker budget allows; none is kept warm.
-`splates worker add --provider [--type <name>]` makes one by hand, past the
-rate cap, and `splates worker remove` destroys its machine.
-
-The worker budget is in dollars, at each type's list price, so every figure is
-an estimate: a rate cap on what the made workers running at once cost an hour
-($0.25/h by default), and limits on what they cost in a day ($5) and a month
-($75), from the start of each in local time. Past the rate cap no worker is
-made, and the queue says which limit holds it, as `rate cap $0.25/h reached`.
-Once a day's or month's limit is spent, made workers take nothing new, their
-agents are asked to stop at a checkpoint, and each is destroyed once its last
-agent ends. Each limit warns at 80%, 90% and 100%, once in its window, by Web
-Push and on the page's header. Agents' own API spend is not counted here.
-
-```bash
-bunx @stringsync/splates budget show
-bunx @stringsync/splates budget set day 10        # or `default`
-bunx @stringsync/splates budget raise hour 0.1 --for 1d
-bunx @stringsync/splates budget end 1             # a raise, by its number
-```
+This machine's own worker runs agents over a private Unix socket and
+reconnects when the server restarts. Remote workers cannot join.
+Use `splates worker list` to inspect it, `splates worker slots local <n>`
+to set its slots, and `splates worker drain local --undo` to resume it.
 
 ### Task ports
 

package/handoff.d.ts

@@ -0,0 +1,13 @@
+/** Set by `checkout.ts` once `splates dev` is mounted on this process. */
+export declare const devMounted: {
+    value: boolean;
+};
+/** The nearest directory at or above `cwd` that is a splates checkout. */
+export declare function checkoutAbove(cwd: string): string | null;
+/**
+ * The release has no `splates dev`, and would print help and exit 0, which
+ * reads as a passing `splates dev test`. Standing in a checkout, run the
+ * checkout's own `bin/splates` instead; anywhere else, fail saying so.
+ * Returns the exit code, or null when `argv` is no `dev` command.
+ */
+export declare function handOffDev(argv: string[], cwd: string): Promise<number | null>;