Skip to content

Conversation

@jimmycallin
Copy link
Contributor

@jimmycallin jimmycallin commented Oct 18, 2025

I got momentarily stuck due to not reading the hosting docs on the fact that you needed to build before deploying the cloudflare examples. I can't figure out a reason why you would want to not build before deploying, so added it to the script to reduce similar friction for people like myself.

Summary by CodeRabbit

  • Documentation

    • Updated hosting guides for React and Solid frameworks to reflect streamlined deployment workflow.
  • Chores

    • Updated deploy scripts to automatically execute build before deployment, simplifying the overall deployment process.

@github-actions github-actions bot added the documentation Everything documentation related label Oct 18, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 18, 2025

Walkthrough

The deploy script workflow is simplified by consolidating the build step into the deploy command itself. Documentation and example package.json files across React and Solid frameworks are updated to reflect this unified deployment process, reducing the need for manual multi-step command execution.

Changes

Cohort / File(s) Summary
Framework hosting guides
docs/start/framework/react/guide/hosting.md, docs/start/framework/solid/guide/hosting.md
Deploy script updated from wrangler deploy to npm run build && wrangler deploy. Step labels changed from "Build and deploy" to "Deploy". Example CLI commands simplified from multi-step to single deploy invocation.
React example deployment
examples/react/start-basic-cloudflare/package.json
Deploy script chained with build: changed from wrangler deploy to npm run build && wrangler deploy.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

These are homogeneous, straightforward configuration and documentation updates with no logic complexity. All changes follow an identical pattern of consolidating build and deploy steps across multiple files.

Possibly related PRs

  • TanStack/router#5252: Modifies Cloudflare deployment docs and package.json deploy scripts with similar build-and-deploy sequence updates.
  • TanStack/router#5357: Adjusts Cloudflare hosting documentation and deployment CLI flow in package.json scripts.

Poem

🐰 Build before you hop away,
One command rules deploy day,
No more steps to chase and chase,
Simplicity wins the race! 🚀

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The pull request title "chore(examples): Always build before deploy in cloudflare workers examples" directly and accurately summarizes the main change. The changeset updates the deploy script across multiple files to chain a build step before deployment (changing from wrangler deploy to npm run build && wrangler deploy), and the title clearly reflects this primary objective. The title is specific and avoids vague language, using clear phrasing that a teammate reviewing the commit history would immediately understand as describing a deliberate modification to the deployment workflow.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 and usage tips.

@jimmycallin jimmycallin changed the title chore(examples): Always build before deploy chore(examples): Always build before deploy on cloudflare workers exampels Oct 18, 2025
@jimmycallin jimmycallin changed the title chore(examples): Always build before deploy on cloudflare workers exampels chore(examples): Always build before deploy in cloudflare workers examples Oct 18, 2025
@SeanCassiere SeanCassiere merged commit 4693e0e into TanStack:main Oct 18, 2025
2 checks passed
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.

2 participants