Skip to content

[Sandbox] Pin package versions and align wording - #34570

Closed
ghostwriternr wants to merge 4 commits into
sandbox/audit-migration-clarityfrom
sandbox/audit-mechanical
Closed

ghostwriternr wants to merge 4 commits into
sandbox/audit-migration-clarityfrom
sandbox/audit-mechanical

Conversation

@ghostwriternr

Copy link
Copy Markdown
Member

Summary

Version pins and wording had drifted across the Sandbox pages.

  • Six install steps added @cloudflare/sandbox without a version, while the same pages copy sandbox-shim from the cloudflare/sandbox:1.0.1 image. The package and the helper must come from the same release, and an older helper rejects commands that a newer package sends. Every install step now pins @cloudflare/sandbox@1.0.1, and the package reference says why.
  • Three migration pages told readers to copy a step that declares INACTIVITY_TIMEOUT_MS a second time, so the Worker failed to compile. They now say to leave the constant out.
  • Pages say "container" instead of "instance", and no longer define a container as a Linux virtual machine. Sandbox lifetime keeps "instance", where it tells one run from the next.
  • The long sandbox-shim COPY line is wrapped on all 14 pages.

Documentation checklist

The line that copies sandbox-shim from the cloudflare/sandbox image is
too wide for a code block on 14 pages, so readers scroll sideways to
see the destination path.

Break each COPY after the source image and indent the two paths, on
every page at once so the line reads the same everywhere.
Pages outside Sandbox lifetime called each running container an
instance and defined it at length as a Linux virtual machine that
runs your image, which readers who know containers do not need.

Say container, keep instance only on Sandbox lifetime where it tells
one run from the next, and leave the virtual machine to the security
concept and the local-versus-deployed note in get-started.
Six install steps added @cloudflare/sandbox without a version while
the same pages copy sandbox-shim from the 1.0.1 image. The package
and the helper must come from the same release, and an older helper
rejects commands that a newer package sends, so the next release
would break those pages.

Install @cloudflare/sandbox@1.0.1 everywhere, matching the image, and
say on the package reference why the version is exact and that both
versions change together.
Three migration pages tell readers to copy step 1 of Run a server in
the background into a file that already defines INACTIVITY_TIMEOUT_MS
from Replace the Sandbox class, so the Worker failed to build with a
redeclared constant.

Tell readers to leave that constant out, as the background process
page does.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://sandbox-audit-mechanical.previews.developers.cloudflare.com (commit f93d8f2)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://2a43828f.previews.developers.cloudflare.com f93d8f2 2026-10-23T16:32:06.063Z Visit the dashboard ↗

@github-actions

Copy link
Copy Markdown
Contributor

Worker Preview URL: https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com
Worker Preview Deployment URL: https://89b36da6.previews.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/sandbox/files/save-and-restore-a-workspace/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/files/save-and-restore-a-workspace/
https://developers.cloudflare.com/sandbox/files/manage-files/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/files/manage-files/
https://developers.cloudflare.com/sandbox/files/save-a-sandbox-automatically/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/files/save-a-sandbox-automatically/
https://developers.cloudflare.com/sandbox/reference/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/reference/
https://developers.cloudflare.com/sandbox/get-started/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/get-started/
https://developers.cloudflare.com/sandbox/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/
https://developers.cloudflare.com/sandbox/files/back-up-a-directory-to-r2/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/files/back-up-a-directory-to-r2/
https://developers.cloudflare.com/sandbox/files/mount-an-r2-bucket/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/files/mount-an-r2-bucket/
https://developers.cloudflare.com/sandbox/get-started/build-a-coding-agent-runner/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/get-started/build-a-coding-agent-runner/
https://developers.cloudflare.com/sandbox/sdk/migrate/move-side-by-side/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/sdk/migrate/move-side-by-side/
https://developers.cloudflare.com/sandbox/sdk/migrate/backups/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/sdk/migrate/backups/
https://developers.cloudflare.com/sandbox/sdk/migrate/code-interpreter/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/sdk/migrate/code-interpreter/
https://developers.cloudflare.com/sandbox/sdk/migrate/other-features/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/sdk/migrate/other-features/
https://developers.cloudflare.com/sandbox/sdk/migrate/replace-the-sandbox-class/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/sdk/migrate/replace-the-sandbox-class/
https://developers.cloudflare.com/sandbox/commands/run-a-server-in-the-background/ https://gh-sandbox-audit-mechanical.previews.developers.cloudflare.com/sandbox/commands/run-a-server-in-the-background/

@cloudflare-docs-bot

Copy link
Copy Markdown
Contributor

@ghostwriternr This draft pull request has had no activity for 3 days. It will close after 7 days of inactivity. Transition to ready for review if ready. A codeowner can comment /draft-never-stale to keep it open.

@cloudflare-docs-bot

Copy link
Copy Markdown
Contributor

@ghostwriternr Closing this draft pull request after 7 days of inactivity. Re-open at a later date and transition to ready for review when you are ready if you seek review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant