Skip to content

docs(start): troubleshoot Cloudflare deployment config - #8396

Open
tannerlinsley wants to merge 1 commit into
mainfrom
taren/start-cloudflare-deploy-troubleshooting
Open

tannerlinsley wants to merge 1 commit into
mainfrom
taren/start-cloudflare-deploy-troubleshooting

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Sep 12, 2026

Copy link
Copy Markdown
Member

🎯 Changes

Explain why Cloudflare deployment can fail after a successful Vite build when wrangler deploy --config wrangler.jsonc bypasses the generated deployment config. Show the build and dry-run commands, how to preserve generated output between CI jobs, and how to select a named environment at build time.

The existing Cloudflare browser suite now includes a deployment dry run using the generated config. This addresses the configuration mistake reported in #5554 without adding an external-module workaround or changing the source server entry.

Validation: the explicit source-config dry run reproduced the missing-entry error; the generated-config dry run passed. All 4 Cloudflare preview/dry-run tests passed. A temporary staging config verified build-time environment selection and passed a dry run, then the source config and default build were restored. Required lint, type, unit, and formatting checks passed. No Worker was published, and live account permissions or deployed bindings were not tested.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with the relevant test commands, or tests do not apply to this pull request.
  • I fully understand the code in this pull request.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation

    • Added troubleshooting guidance for Cloudflare Workers deployments that fail despite successful Vite builds.
    • Documented how to validate deployment packaging with dry runs, preserve generated deployment files across build and deploy steps, and configure named environments correctly.
    • Clarified the limitations of dry-run validation, including account permissions, domains, and deployed bindings.
  • Tests

    • Added end-to-end coverage verifying that Cloudflare deployment dry runs use the generated deployment configuration and complete successfully.

@github-actions github-actions Bot added the documentation Everything documentation related label Sep 12, 2026
@nx-cloud

nx-cloud Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 6ec9f33

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded 2m 21s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 2m 16s View ↗

☁️ Nx Cloud last updated this comment at 2026-09-12 04:33:39 UTC

@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 03ebc202-76a0-494a-beab-183aa7482f04

📥 Commits

Reviewing files that changed from the base of the PR and between 05422da and 6ec9f33.

📒 Files selected for processing (2)
  • docs/start/framework/react/guide/hosting.md
  • e2e/react-start/basic-cloudflare/tests/app.spec.ts

Included review availability: Your plan provides up to 10 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The PR adds Cloudflare Workers deployment troubleshooting guidance for React Start and an end-to-end test that validates Wrangler dry-run output against the generated server configuration.

Changes

Cloudflare deployment validation

Layer / File(s) Summary
Deployment configuration troubleshooting
docs/start/framework/react/guide/hosting.md
Documents generated Wrangler configuration, dry-run validation, build and deploy job requirements, environment selection, and dry-run limitations.
Cloudflare dry-run test
e2e/react-start/basic-cloudflare/tests/app.spec.ts
Runs the local Wrangler CLI with --dry-run and checks for dist/server/wrangler.json and the dry-run exit message.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 6ec9f

The PR adds troubleshooting guidance and dry-run coverage without introducing a concrete deployment risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description explains the documentation and test changes, records validation results and limitations, and completes all required checklist and release-impact sections.
Title check ✅ Passed The title clearly identifies the main change: troubleshooting Cloudflare deployment configuration issues in the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch taren/start-cloudflare-deploy-troubleshooting

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

3 package(s) bumped directly, 21 bumped as dependents.

🟩 Patch bumps

Package Version Reason
@tanstack/history 1.162.3 → 1.162.4 Changeset
@tanstack/router-core 1.171.29 → 1.171.30 Changeset
@tanstack/start-server-core 1.169.34 → 1.169.35 Changeset
@tanstack/react-router 1.170.35 → 1.170.36 Dependent
@tanstack/react-start 1.168.52 → 1.168.53 Dependent
@tanstack/react-start-client 1.168.33 → 1.168.34 Dependent
@tanstack/react-start-rsc 0.1.51 → 0.1.52 Dependent
@tanstack/react-start-server 1.167.40 → 1.167.41 Dependent
@tanstack/router-cli 1.167.35 → 1.167.36 Dependent
@tanstack/router-generator 1.167.35 → 1.167.36 Dependent
@tanstack/router-plugin 1.168.37 → 1.168.38 Dependent
@tanstack/router-vite-plugin 1.167.37 → 1.167.38 Dependent
@tanstack/solid-router 1.170.33 → 1.170.34 Dependent
@tanstack/solid-start 1.168.50 → 1.168.51 Dependent
@tanstack/solid-start-client 1.168.32 → 1.168.33 Dependent
@tanstack/solid-start-server 1.167.39 → 1.167.40 Dependent
@tanstack/start-client-core 1.170.29 → 1.170.30 Dependent
@tanstack/start-plugin-core 1.171.42 → 1.171.43 Dependent
@tanstack/start-static-server-functions 1.167.34 → 1.167.35 Dependent
@tanstack/start-storage-context 1.167.31 → 1.167.32 Dependent
@tanstack/vue-router 1.170.32 → 1.170.33 Dependent
@tanstack/vue-start 1.168.49 → 1.168.50 Dependent
@tanstack/vue-start-client 1.167.35 → 1.167.36 Dependent
@tanstack/vue-start-server 1.167.39 → 1.167.40 Dependent

@pkg-pr-new

pkg-pr-new Bot commented Sep 12, 2026

Copy link
Copy Markdown
More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@8396

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@8396

@tanstack/eslint-plugin-start

npm i https://pkg.pr.new/@tanstack/eslint-plugin-start@8396

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@8396

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/@tanstack/nitro-v2-vite-plugin@8396

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@8396

@tanstack/react-router-devtools

npm i https://pkg.pr.new/@tanstack/react-router-devtools@8396

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/@tanstack/react-router-ssr-query@8396

@tanstack/react-start

npm i https://pkg.pr.new/@tanstack/react-start@8396

@tanstack/react-start-client

npm i https://pkg.pr.new/@tanstack/react-start-client@8396

@tanstack/react-start-rsc

npm i https://pkg.pr.new/@tanstack/react-start-rsc@8396

@tanstack/react-start-server

npm i https://pkg.pr.new/@tanstack/react-start-server@8396

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@8396

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@8396

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@8396

@tanstack/router-devtools-core

npm i https://pkg.pr.new/@tanstack/router-devtools-core@8396

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@8396

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@8396

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/@tanstack/router-ssr-query-core@8396

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@8396

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@8396

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@8396

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/@tanstack/solid-router-devtools@8396

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/@tanstack/solid-router-ssr-query@8396

@tanstack/solid-start

npm i https://pkg.pr.new/@tanstack/solid-start@8396

@tanstack/solid-start-client

npm i https://pkg.pr.new/@tanstack/solid-start-client@8396

@tanstack/solid-start-server

npm i https://pkg.pr.new/@tanstack/solid-start-server@8396

@tanstack/start-client-core

npm i https://pkg.pr.new/@tanstack/start-client-core@8396

@tanstack/start-fn-stubs

npm i https://pkg.pr.new/@tanstack/start-fn-stubs@8396

@tanstack/start-plugin-core

npm i https://pkg.pr.new/@tanstack/start-plugin-core@8396

@tanstack/start-server-core

npm i https://pkg.pr.new/@tanstack/start-server-core@8396

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/@tanstack/start-static-server-functions@8396

@tanstack/start-storage-context

npm i https://pkg.pr.new/@tanstack/start-storage-context@8396

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@8396

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@8396

@tanstack/vue-router

npm i https://pkg.pr.new/@tanstack/vue-router@8396

@tanstack/vue-router-devtools

npm i https://pkg.pr.new/@tanstack/vue-router-devtools@8396

@tanstack/vue-router-ssr-query

npm i https://pkg.pr.new/@tanstack/vue-router-ssr-query@8396

@tanstack/vue-start

npm i https://pkg.pr.new/@tanstack/vue-start@8396

@tanstack/vue-start-client

npm i https://pkg.pr.new/@tanstack/vue-start-client@8396

@tanstack/vue-start-server

npm i https://pkg.pr.new/@tanstack/vue-start-server@8396

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@8396

commit: 6ec9f33

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

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant