Skip to content

chore: rename task.md 'environment:' key to 'sandbox:' - #28

Merged
xdotli merged 1 commit into
mainfrom
chore/rename-environment-to-sandbox
Aug 9, 2026
Merged

chore: rename task.md 'environment:' key to 'sandbox:'#28
xdotli merged 1 commit into
mainfrom
chore/rename-environment-to-sandbox

Conversation

@xdotli

@xdotli xdotli commented Aug 9, 2026

Copy link
Copy Markdown
Member

Why

benchflow is renaming the top-level task-config frontmatter key environment: to sandbox:. This will be a hard rename (no alias): once it lands in benchflow, only sandbox: will parse.

Current benchflow — released 0.6.6 and 0.6.7.dev main — accepts both spellings, so this PR is safe to merge immediately on any version. Migrating now future-proofs env0 for the hard rename with zero breakage during the compatibility window.

What changed

  • All 68 task.md files under tasks/ and example_tasks/: the top-level frontmatter key environment:sandbox: (one line per file, values untouched).

Explicitly unchanged

  • benchflow.environment.manifest (the environment: sub-key nested under the benchflow: orchestration section) — this is a different subsystem (the Environment-plane manifest binding), not the sandbox resource config. All 68 occurrences verified unchanged.
  • tasks/_manifests/*.toml
  • Docs prose about the mock-services "environment" (README.md, docs/dev.md)

Verification

  • Files changed (68) == files that had the old top-level key (68); git grep '^environment:' over task.md files now returns nothing; sandbox: count is 68.
  • Indented benchflow.environment occurrences: 68 before == 68 after; manifest occurrences in .md: 77 before == 77 after.
  • Parsed 3 migrated tasks (tasks/gdoc-search-keyword-index, tasks/stripe-balance-reconciliation, example_tasks/multi-misread-approval-scope) with current benchflow main (0.6.7.dev0) via benchflow.task.document.TaskDocument.from_path: all parse, the sandbox: values land in TaskConfig (cpus/memory_mb/network_mode/os/storage_mb/gpus all correct, confirmed non-default by mutation test), and benchflow.environment.manifest still resolves.

benchflow is renaming the top-level task-config frontmatter key
'environment:' to 'sandbox:' (hard rename, no alias once it lands).
Current benchflow releases (0.6.6 and 0.6.7.dev main) accept both
spellings, so this migration is safe to merge immediately on any
released version; it future-proofs env0 for the hard rename, after
which only 'sandbox:' will parse.

Scope: the top-level frontmatter key in all 68 task.md files under
tasks/ and example_tasks/. The 'benchflow.environment.manifest'
orchestration key is a different subsystem (Environment-plane manifest
binding) and is intentionally unchanged, as are _manifests/*.toml and
docs prose about the mock-services environment.
@xdotli
xdotli merged commit a292cc5 into main Aug 9, 2026
11 checks passed
@xdotli
xdotli deleted the chore/rename-environment-to-sandbox branch August 9, 2026 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant