Skip to content

Doc backup exclude options per SDK#437 - #28761

Closed
ask-bonk[bot] wants to merge 1 commit into
productionfrom
opencode/issue28760-20260304095328
Closed

ask-bonk[bot] wants to merge 1 commit into
productionfrom
opencode/issue28760-20260304095328

Conversation

@ask-bonk

@ask-bonk ask-bonk Bot commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

All checks pass. Here is a summary of the documentation changes made based on cloudflare/sandbox-sdk#437:

Changes

src/content/docs/sandbox/api/backups.mdx (API reference)

  1. Parameters section (createBackup()): Added exclude and excludeDefaults parameter descriptions
  2. Throws section: Updated InvalidBackupConfigError description to cover validation of exclude (non-string values, control characters) and excludeDefaults (non-boolean)
  3. BackupOptions type definition: Added exclude?: string[] and excludeDefaults?: boolean fields
  4. BackupOptions fields table: Added documentation for both new fields, including the default exclude list and merge behavior

src/content/docs/sandbox/guides/backup-restore.mdx (how-to guide)

  1. New "Exclude files from backups" section with three subsections:
    • Use default excludes — example using excludeDefaults: true
    • Specify custom exclude patterns — example using the exclude array
    • Combine defaults with custom patterns — example using both together
  2. Best practices: Added a new bullet recommending excludeDefaults / exclude to reduce archive size

Closes #28760

github run

Co-authored-by: whoiskatrin <whoiskatrin@users.noreply.github.com>
@github-actions

github-actions Bot commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/sandbox/ @whoiskatrin, @ghostwriternr, @cloudflare/pcx-technical-writing, @cloudflare/ai-agents

@github-actions

Copy link
Copy Markdown
Contributor

Hey there, we've marked this pull request as stale because there's no recent activity on it. This label is helps us identify PRs that might need updates (or to be closed out by our team if no longer relevant).

@github-actions github-actions Bot added the stale label Mar 19, 2026
@github-actions
github-actions Bot deleted the opencode/issue28760-20260304095328 branch May 4, 2026 05:09
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.

sandbox-sdk: backup api improvements to include / exclude files

2 participants