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

@jamesopstad jamesopstad commented May 22, 2026

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 github-actions Bot added product:workers Related to Workers product size/s labels May 22, 2026
@github-actions

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

@jamesopstad jamesopstad mentioned this pull request May 22, 2026
Merged
5 tasks
ask-bonk[bot]
ask-bonk Bot reviewed May 22, 2026
View reviewed changes

@ask-bonk ask-bonk Bot left a comment

Copy link
Copy Markdown
Contributor

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

ask-bonk Bot commented May 22, 2026

Copy link
Copy Markdown
Contributor

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

github-actions Bot commented May 22, 2026

Copy link
Copy Markdown
Contributor

Preview URL: https://76b66c25.preview.developers.cloudflare.com
Preview Branch URL: https://james-dev-only-option.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/vite-plugin/reference/api/ https://james-dev-only-option.preview.developers.cloudflare.com/workers/vite-plugin/reference/api/

@github-actions

github-actions Bot commented Jun 6, 2026

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 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 Jun 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ask-bonk ask-bonk[bot] ask-bonk[bot] left review comments
@GregBrimble GregBrimble Awaiting requested review from GregBrimble GregBrimble will be requested when the pull request is marked ready for review GregBrimble is a code owner
@irvinebroque irvinebroque Awaiting requested review from irvinebroque irvinebroque will be requested when the pull request is marked ready for review irvinebroque is a code owner
@korinne korinne Awaiting requested review from korinne korinne will be requested when the pull request is marked ready for review korinne is a code owner
@WalshyDev WalshyDev Awaiting requested review from WalshyDev WalshyDev will be requested when the pull request is marked ready for review WalshyDev is a code owner
@MattieTK MattieTK Awaiting requested review from MattieTK MattieTK will be requested when the pull request is marked ready for review MattieTK is a code owner
@vy-ton vy-ton Awaiting requested review from vy-ton vy-ton will be requested when the pull request is marked ready for review vy-ton is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@MattieTK MattieTK

@irvinebroque irvinebroque

@mikenomitch mikenomitch

@GregBrimble GregBrimble

@WalshyDev WalshyDev

@korinne korinne

Labels

product:workers Related to Workers product size/s stale

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@jamesopstad @MattieTK @irvinebroque @mikenomitch @GregBrimble @WalshyDev @korinne