Skip to content

Add devOnly option to Vite plugin API reference#31016

Draft
jamesopstad wants to merge 1 commit into
productionfrom
james/dev-only-option
Draft

Add devOnly option to Vite plugin API reference#31016
jamesopstad wants to merge 1 commit into
productionfrom
james/dev-only-option

Conversation

@jamesopstad
Copy link
Copy Markdown
Contributor

Summary

Add devOnly option to Vite plugin API reference

Screenshots (optional)

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions
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/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @korinne, @WalshyDev, @cloudflare/deploy-config, @cloudflare/product-owners, @cloudflare/wrangler, @MattieTK, @cloudflare/dev-plat-leads

Copy link
Copy Markdown
Contributor

@ask-bonk ask-bonk Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean docs update. No issues found.

@ask-bonk
Copy link
Copy Markdown
Contributor

ask-bonk Bot commented May 22, 2026

Posted a review on PR #31016.

Summary: Clean docs update — no issues found.

What changes: Adds documentation for the devOnly option (a boolean | (() => boolean)) to both the PluginConfig and AuxiliaryWorkerConfig sections of the Vite plugin API reference page. The option excludes a Worker from the production build when set to true, with special handling for entry Workers that writes an assets-only Wrangler config for static deployment.

Labels already applied: product:workers, size/s — appropriate for this change. Appropriate labels: documentation, size/s. The PR could also benefit from a documentation label.

No critical issues, high issues, or style guide violations detected. The PR follows existing page conventions, uses correct component syntax (Type, MetaInfo), and the prose is clear and consistent with the rest of the API reference. No changelog entry is needed for this docs-only addition.

github run

@github-actions
Copy link
Copy Markdown
Contributor

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

Labels

product:workers Related to Workers product size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants