bitfab-cli 0.2.404 → 0.2.405
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +16 -12
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -24697,10 +24697,10 @@ var semver3 = __toESM(require_semver2(), 1);
|
|
|
24697
24697
|
|
|
24698
24698
|
// ../bitfab-plugin-lib/dist/bakedSdkVersions.js
|
|
24699
24699
|
var BAKED_SDK_VERSIONS = {
|
|
24700
|
-
typescript: "0.62.
|
|
24701
|
-
python: "0.62.
|
|
24702
|
-
ruby: "0.62.
|
|
24703
|
-
go: "0.62.
|
|
24700
|
+
typescript: "0.62.7",
|
|
24701
|
+
python: "0.62.6",
|
|
24702
|
+
ruby: "0.62.6",
|
|
24703
|
+
go: "0.62.6"
|
|
24704
24704
|
};
|
|
24705
24705
|
|
|
24706
24706
|
// ../bitfab-plugin-lib/dist/installedSdk.js
|
|
@@ -31405,7 +31405,11 @@ Never modify existing code on a refactor path without completing this three-step
|
|
|
31405
31405
|
|
|
31406
31406
|
Choose one existing replay registry and reproduce its runtime, dependency installation, build steps, working directory, caches, and required services from CI. Cover what every pipeline in that registry needs, since cloud replay allows all of them by default. Use the installed SDK's cloud-capable CLI: run its bitfab-replay --cloud --help now. If it does not list --cloud-init, the project's SDK predates this setup, so upgrade it through bitfab:update before continuing. The code that submits, watches, and runs cloud replays ships inside the SDK and updates with it; the repository keeps only settings: .bitfab/cloud.json and a workflow whose Replay step runs the SDK's bitfab-replay command with --cloud-execute. The runner reports its result as a job annotation, so the workflow needs no upload step. When the repository already has an older generated workflow (a Save replay identity upload step, a job timeout-minutes of 35, or a Replay step that runs .bitfab/cloudReplay.py), offer to update it: from workingDirectory run the SDK's bitfab-replay command with --cloud-init. On an existing setup it rewrites the Replay step to run the SDK command and removes two things older setups generated that the SDK now owns: the separate Save replay identity upload step and a job timeout-minutes of exactly 35. It keeps the checkout, other setup steps, secrets, runner, environment, services, and any timeout the user chose, and does nothing when the setup is already current. When the old step ran .bitfab/cloudReplay.py rather than the SDK, pass --config with a JSON file holding just cliCommand, the argv that starts bitfab-replay from workingDirectory. Delete any file the result lists as removable. Show the diff, and treat merging it like any other workflow change. TypeScript/Python/Ruby registry imports happen on the runner only. Go must dispatch cloud flags before building its registry or initializing the application. For database reads, prefer database branching. When the Bitfab organization has a database connected, each replay item gets a branch at its trace's captured instant, and the runner needs no database secret. That works only when every registry entry that reads the database sets dbBranch, and the application takes its connection per call from the replay branch URL (getCurrentReplayBranch().databaseUrl, or the Python, Ruby, or Go equivalent), falling back to its normal URL. A pool or engine created once at import from DATABASE_URL never sees the branch, and the SDK does not change DATABASE_URL, so check how the application builds its database client. When either piece is missing, offer to run db-snapshot mode first. Without branching, a private database needs runner network access or a replay-safe service fixture. Do not silently give replay production side effects. Submodules/gitlinks and credential-like tracked files are rejected by the snapshot helper. A gitlink with no .gitmodules entry is usually a nested repository committed by accident: offer to untrack it with git rm --cached and ignore its folder. Surface blockers instead of claiming the environment is ready.
|
|
31407
31407
|
|
|
31408
|
-
|
|
31408
|
+
Say plainly which identity the runner uses: it authenticates only with the credentials in its GitHub secrets, never as the user. Local gcloud, AWS, or other cloud logins do not travel to the runner, so a bucket or API the user can reach from their laptop can still refuse the runner. When a cloud credential secret is a service account, ask for the account's email (never the key), and when the user's own CLI is logged in, check that the account can read what replay reads with an impersonated read, such as gcloud storage ls gs://<bucket> --impersonate-service-account=<email> or aws sts assume-role for a role. Report a refusal as the fix to make before the first run, not a warning.
|
|
31409
|
+
|
|
31410
|
+
State who can start a replay: once GitHub has registered the workflow, anyone with write access to the repository can dispatch it on any branch, including code the user never reviewed, and that run receives every runner secret. Recommend a GitHub Environment by default (environment: bitfab-replay) holding the replay secrets, with required reviewers, so no run gets credentials until someone approves it. Name the tradeoff: every replay then waits for an approval. Let the user decline, and record the choice.
|
|
31411
|
+
|
|
31412
|
+
Present the proposed workflow, fixed replay command, required secret/variable names, the Environment choice, and any required CI trigger exclusions. Ask only about unresolved project choices. Never ask for secret values in chat.`,
|
|
31409
31413
|
next: "cloud/install"
|
|
31410
31414
|
},
|
|
31411
31415
|
{
|
|
@@ -31413,15 +31417,15 @@ Present the proposed workflow, fixed replay command, required secret/variable na
|
|
|
31413
31417
|
kind: "action",
|
|
31414
31418
|
title: "Install the cloud replay settings",
|
|
31415
31419
|
toolCalls: ["bash", "read", "write", "edit"],
|
|
31416
|
-
body: `Create a reviewed JSON setup specification containing version: 1, provider: "github", workflow: "bitfab-replay.yml", workingDirectory (repository-relative), registry (repository-relative path or null for Go), pipeline (null allows every pipeline in the registry and is the default; a name restricts replay to that one pipeline, for when the others need credentials or services the runner should not have), command (the JSON argv array the runner uses to run the replay itself: the project's normal bitfab-replay invocation including --registry when the registry needs it, without the pipeline argument or any cloud flags; the runner appends the pipeline, --trace-ids, and --max-concurrency), cliCommand (the JSON argv array that starts the SDK's bitfab-replay command from workingDirectory, with no flags, such as ["npx", "--no-install", "bitfab-replay"] or ["node", "node_modules/@bitfab/sdk/dist/replayCli.js"]; the generated Replay step runs it with --cloud-execute), pushTriggersReviewed: true, setupSteps (GitHub Actions step objects), secrets (names including BITFAB_API_KEY), and variables (names only). The runner always provides BITFAB_API_KEY. Find the variable the registry's Bitfab client actually reads its key from, and when it is another name, map it in the command, for example ["sh", "-c", "APP_KEY_NAME=\\"$BITFAB_API_KEY\\" exec <command> \\"$@\\"", "sh"]. Optional secretPrefix (uppercase, ending in an underscore) names the GitHub secret each one is read from without changing the environment variable the replay sees; it defaults to BITFAB_CLOUD_, and only an explicit empty string turns prefixing off. Optional runsOn
|
|
31420
|
+
body: `Create a reviewed JSON setup specification containing version: 1, provider: "github", workflow: "bitfab-replay.yml", workingDirectory (repository-relative), registry (repository-relative path or null for Go), pipeline (null allows every pipeline in the registry and is the default; a name restricts replay to that one pipeline, for when the others need credentials or services the runner should not have), command (the JSON argv array the runner uses to run the replay itself: the project's normal bitfab-replay invocation including --registry when the registry needs it, without the pipeline argument or any cloud flags; the runner appends the pipeline, --trace-ids, and --max-concurrency), cliCommand (the JSON argv array that starts the SDK's bitfab-replay command from workingDirectory, with no flags, such as ["npx", "--no-install", "bitfab-replay"] or ["node", "node_modules/@bitfab/sdk/dist/replayCli.js"]; the generated Replay step runs it with --cloud-execute), pushTriggersReviewed: true, setupSteps (GitHub Actions step objects), secrets (names including BITFAB_API_KEY), and variables (names only). Use optional env for anything else the replay step needs, mapping each environment variable name to {"secret": "<GitHub secret name>"} when the secret has another name, such as "OPENAI_API_KEY": {"secret": "EVAL_OPENAI_API_KEY"}, or to {"variable": "<repository variable name>"} for a non-secret value. Never hand-edit these into the workflow: cloud.json is what --cloud-secrets and the runner's empty-secret check read, so a mapping that lives only in the workflow is set under the wrong name and never checked. Optional checkCommand is a JSON argv array the runner executes from workingDirectory during --cloud-check, before any replay, to prove the environment works, such as a small script that reads one object from the bucket replay uses; propose one when replay reads cloud storage or another service with its own credentials. The runner always provides BITFAB_API_KEY. Find the variable the registry's Bitfab client actually reads its key from, and when it is another name, map it in the command, for example ["sh", "-c", "APP_KEY_NAME=\\"$BITFAB_API_KEY\\" exec <command> \\"$@\\"", "sh"]. Optional secretPrefix (uppercase, ending in an underscore) names the GitHub secret each one is read from without changing the environment variable the replay sees; it defaults to BITFAB_CLOUD_, and only an explicit empty string turns prefixing off. Optional runsOn and services match the existing CI. Set environment to the Environment chosen during inspection (bitfab-replay by default). When a setup step needs a credential file, such as a Google service account JSON, write it under $RUNNER_TEMP with umask 077 and export its path through $GITHUB_ENV: a step whose env maps GOOGLE_CREDENTIALS_JSON from its secret and whose run is umask 077; printf '%s' "$GOOGLE_CREDENTIALS_JSON" > "$RUNNER_TEMP/google.json"; echo "GOOGLE_APPLICATION_CREDENTIALS=$RUNNER_TEMP/google.json" >> "$GITHUB_ENV", and keep the name in secrets so the empty-secret check covers it. Do not use google-github-actions/auth or similar actions that write the key file into the checked-out workspace. Pin third-party actions to reviewed commit SHAs. Ensure Python 3.10+ exists on the runner. Commands run in workingDirectory. Registry in the command must be relative to that directory. Set step working-directory explicitly where needed. Do not copy deployment steps, local env values, or API keys into the specification.
|
|
31417
31421
|
|
|
31418
31422
|
From workingDirectory, run the SDK's bitfab-replay command with --cloud-init --config <specification-path>. This creates .bitfab/cloud.json and .github/workflows/bitfab-replay.yml. The generated workflow is JSON, which is valid YAML. Its run-name and its execution_id and request inputs are how the SDK finds and feeds each run; never rename them. Running --cloud-init again is safe: on an existing setup it ignores the rest of the specification and only brings the Replay step up to date as described above, so change other settings by editing the files and reviewing the diff. Remove only your temporary specification after successful installation. If .bitfab is ignored, propose a narrow gitignore exception for .bitfab/cloud.json. Never force-add secrets or arbitrary ignored files.
|
|
31419
31423
|
|
|
31420
|
-
Tell the user which repository or Environment secrets to create in GitHub Settings \u2192 Secrets and variables \u2192 Actions. BITFAB_API_KEY belongs to the Bitfab organization that holds the registry's traces; confirm that with the user, because a key from another organization finds none of them. Other names come from their application, such as OPENAI_API_KEY. BITFAB_SERVICE_URL is optional. Do not override the SDK's default with an empty GitHub variable. Runtime secrets belong on the replay step. Any install-time credentials need explicit references on the relevant setup step. Local gh authentication is separate from these runner secrets. Do not create a Bitfab cloud target, install a GitHub App, or request a repository connection.
|
|
31424
|
+
Tell the user which repository or Environment secrets to create in GitHub Settings \u2192 Secrets and variables \u2192 Actions. BITFAB_API_KEY belongs to the Bitfab organization that holds the registry's traces; confirm that with the user, because a key from another organization finds none of them. Have the user create a dedicated key for the runner on the API keys page of the Bitfab dashboard, named for what it is (such as "GitHub cloud replay"), rather than reusing the key the plugin logged in with or their personal development key, so it can be revoked or rotated without touching anyone's own setup. Other names come from their application, such as OPENAI_API_KEY. BITFAB_SERVICE_URL is optional. Do not override the SDK's default with an empty GitHub variable. Runtime secrets belong on the replay step. Any install-time credentials need explicit references on the relevant setup step. Local gh authentication is separate from these runner secrets. Do not create a Bitfab cloud target, install a GitHub App, or request a repository connection.
|
|
31421
31425
|
|
|
31422
|
-
Init records the secret names and the resolved prefix in .bitfab/cloud.json, so later lifecycle commands reuse them without being told again. Runner secrets are prefixed BITFAB_CLOUD_ unless the user asks otherwise, so the runner reads BITFAB_CLOUD_OPENAI_API_KEY and exposes it to the replay as OPENAI_API_KEY. Replay credentials then never collide with secrets the repository already uses, and can carry narrower scopes or a different Bitfab organization than production. Pass a different prefix, or an empty string to reuse the repository's existing bare-named secrets, only when the user wants that. Report the
|
|
31426
|
+
Init records the secret names and the resolved prefix in .bitfab/cloud.json, so later lifecycle commands reuse them without being told again. Runner secrets are prefixed BITFAB_CLOUD_ unless the user asks otherwise, so the runner reads BITFAB_CLOUD_OPENAI_API_KEY and exposes it to the replay as OPENAI_API_KEY. Replay credentials then never collide with secrets the repository already uses, and can carry narrower scopes or a different Bitfab organization than production. Pass a different prefix, or an empty string to reuse the repository's existing bare-named secrets, only when the user wants that. Report the names in requiredSecrets and requiredVariables as the ones to create. When --cloud-init on an existing setup reports conflicts or undeclared names, the Replay step sets those differently from cloud.json or without it; move each one into cloud.json env and rerun, so --cloud-secrets and the empty-secret check agree with the workflow.
|
|
31423
31427
|
|
|
31424
|
-
When the project keeps local environment files, list the NAMES each required secret could come from and ask whether to copy those local values into GitHub. Never read, print, or compare the values, and ask once for the whole set rather than per secret. On a yes, run the SDK's bitfab-replay command with --cloud-secrets --env-file <file> [--env-file <file>] [--environment <name>], which reads the recorded names and prefix, parses quoted, multi-line, and JSON values correctly, and pipes each value to gh on standard input so it never appears in arguments, process listings, or shell history. Never hand-extract a value with grep, cut, or a shell variable, and never pass one through gh secret set --body. Use --dry-run first to report which names the files define. The command reports set, missing, and empty names only; create the missing ones by hand. A name your files define as blank is skipped rather than uploaded, because an empty secret replaces a working default with nothing. Warn before copying a value whose own configuration points somewhere a runner cannot reach, such as a localhost service URL, or that grants more than the replay needs, and let the user decide.
|
|
31428
|
+
When the project keeps local environment files, list the NAMES each required secret could come from and ask whether to copy those local values into GitHub. Never read, print, or compare the values, and ask once for the whole set rather than per secret. On a yes, run the SDK's bitfab-replay command with --cloud-secrets --env-file <file> [--env-file <file>] [--environment <name>], which reads the recorded names and prefix, parses quoted, multi-line, and JSON values correctly, and pipes each value to gh on standard input so it never appears in arguments, process listings, or shell history. Never hand-extract a value with grep, cut, or a shell variable, and never pass one through gh secret set --body. Use --dry-run first to report which names the files define. The command reports set, missing, and empty names only; create the missing ones by hand. A name your files define as blank is skipped rather than uploaded, because an empty secret replaces a working default with nothing. Warn before copying a value whose own configuration points somewhere a runner cannot reach, such as a localhost service URL, or that grants more than the replay needs, and let the user decide. Leave BITFAB_API_KEY out of the copy by default and have the user set the dedicated runner key by hand, since a local file usually holds their personal or development key. Environment secrets need the Environment to exist: check with gh api repos/<owner>/<repo>/environments, and when it is missing, ask before creating it with gh api -X PUT repos/<owner>/<repo>/environments/<name>, offering the user as a required reviewer. Setting secrets requires the same explicit authorization as any other remote write, and a wrong value only surfaces when the first real replay runs, since the dry run never calls the application.`,
|
|
31425
31429
|
next: "cloud/verify"
|
|
31426
31430
|
},
|
|
31427
31431
|
{
|
|
@@ -31429,11 +31433,11 @@ When the project keeps local environment files, list the NAMES each required sec
|
|
|
31429
31433
|
kind: "action",
|
|
31430
31434
|
title: "Verify and hand off",
|
|
31431
31435
|
toolCalls: ["bash", "read", "ask"],
|
|
31432
|
-
body: `Validate workflow syntax (actionlint when available) and run the installed SDK CLI with --cloud --help.
|
|
31436
|
+
body: `Validate workflow syntax (actionlint when available) and run the installed SDK CLI with --cloud --help. GitHub must have registered the workflow before it can be dispatched, and merging it to the default branch once registers it. After that, each replay dispatches the workflow as it is in that replay's snapshot, so later workflow edits apply on the next replay without merging, and the SDK only requires that the workflow is registered and enabled. Explain the required commit/merge for the first registration. Do not push, merge, change repository permissions, or set secrets without authorization.
|
|
31433
31437
|
|
|
31434
|
-
After the setup files are tracked (until then, pass each one with --cloud-include; the helper names any that are missing), run bitfab-replay --cloud <pipeline> --trace-ids <real-trace-uuid> --cloud-dry-run using the selected SDK command. It reports changed tracked files and omitted new files. Include new source files explicitly with repeated --cloud-include <repository-relative-file>. Review the entire snapshot for credentials. Filename screening is not a secret scanner. Then, only when remote replay is authorized, run without --cloud-dry-run. The helper creates a commit through an isolated index, pushes bitfab-replay/<UUID>, dispatches that branch, waits, retrieves the test-run identity, and deletes the branch with an exact-SHA lease. HEAD, staged changes, and working files stay untouched. Never reset or undo the user's work.
|
|
31438
|
+
After the setup files are tracked (until then, pass each one with --cloud-include; the helper names any that are missing), run bitfab-replay --cloud <pipeline> --trace-ids <real-trace-uuid> --cloud-dry-run using the selected SDK command. It reports changed tracked files and omitted new files. Include new source files explicitly with repeated --cloud-include <repository-relative-file>. Review the entire snapshot for credentials. Filename screening is not a secret scanner. Then, once the workflow is merged and the secrets are set, run the same command with --cloud-check in place of --cloud-dry-run, when remote runs are authorized. It dispatches a real run that replays nothing: the runner stops with the names of any configured secrets that are empty (GitHub turns a secret that does not exist into an empty string), runs checkCommand, and resolves the traces with the replay's --dry-run, which loads the registry and proves the Bitfab key reaches the traces. Fix what it reports before the first replay, and read the Replay step log it links when it fails. Then, only when remote replay is authorized, run without --cloud-check. Any replay option the user would pass locally, such as --name, --dataset-ids in place of --trace-ids, --attempts, --judge-assertions, or --resume, goes after the pipeline and is passed to the replay on the runner as given; --params and --code-change files must be in the snapshot. --registry comes from cloud.json, and --dry-run and seeding stay local. Add --fail-on-error when a script should exit 1 on errored items. When items error, the runner prints each item's error, shortened, in the step log and the job summary. The helper creates a commit through an isolated index, pushes bitfab-replay/<UUID>, dispatches that branch, waits, retrieves the test-run identity, and deletes the branch with an exact-SHA lease. HEAD, staged changes, and working files stay untouched. Never reset or undo the user's work.
|
|
31435
31439
|
|
|
31436
|
-
Use --cloud-detach to return immediately; always detach from an agent session, since a replay can run for hours and, once GitHub shows the run, the wait has no local limit (it gives up only when GitHub shows no run for a dispatch within 10 minutes). Pass --cloud-timeout <minutes> (1..7200) to stop one replay early: the runner stops it cleanly and finished traces stay saved as an interrupted experiment. The generated job sets no timeout, so GitHub's 6-hour limit for its own runners applies; longer replays need a self-hosted runner with timeout-minutes set on the job. Explain --cloud-status, --cloud-watch, --cloud-cancel, and --cloud-cleanup with the printed execution UUID. Records live under this worktree's Git directory. Interrupted/lost-response submissions must be recovered, not blindly dispatched again. Cancel requests do not imply the job stopped. Watch/status confirms completion before deleting the branch. Detached jobs do not automatically clean themselves without a later local lifecycle command. Report separately whether files are generated, secrets configured, workflow merged, dry-run verified, and an actual remote replay completed. Never call a mock smoke run a real replay.`,
|
|
31440
|
+
Use --cloud-detach to return immediately; always detach from an agent session, since a replay can run for hours and, once GitHub shows the run, the wait has no local limit (it gives up only when GitHub shows no run for a dispatch within 10 minutes). Pass --cloud-timeout <minutes> (1..7200) to stop one replay early: the runner stops it cleanly and finished traces stay saved as an interrupted experiment. The generated job sets no timeout, so GitHub's 6-hour limit for its own runners applies; longer replays need a self-hosted runner with timeout-minutes set on the job. Explain --cloud-status, --cloud-watch, --cloud-cancel, and --cloud-cleanup with the printed execution UUID. Records live under this worktree's Git directory. Interrupted/lost-response submissions must be recovered, not blindly dispatched again. Cancel requests do not imply the job stopped. Watch/status confirms completion before deleting the branch. Detached jobs do not automatically clean themselves without a later local lifecycle command. Report separately whether files are generated, secrets configured, workflow merged, dry-run verified, cloud check passed, and an actual remote replay completed. Never call a mock smoke run a real replay.`,
|
|
31437
31441
|
next: "cleanup/finish"
|
|
31438
31442
|
}
|
|
31439
31443
|
]
|
package/package.json
CHANGED