docs: deploy build path flags and config file auto-detection - #4858
Conversation
Documents --native-build, --depot-build, --local-bundle, --detach and --build-logs in the deploy command reference, updates the GitHub integration's config file setting to describe auto-detection, and points the resource_exhausted troubleshooting entry at the --native-build flag.
|
WalkthroughThe documentation now states that trigger config files are auto-detected anywhere in a repository by default, with an optional override path. Deployment CLI documentation updates descriptions for native builds, local bundles, Depot builds, and build logs. Troubleshooting guidance recommends Merge Risk: 🔵 Low · up to This documentation change updates deployment build options, but users could misunderstand which provider is selected, treat the experimental local-bundle path as stable, or follow an incorrect native-build troubleshooting link. The PR is mergeable with explicit owner follow-up on these bounded documentation risks. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation 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 0 files. (1 skipped: 1 unsupported.)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Team
Run ID: c8eabf95-15d3-40e7-8261-bbbf4a6e8000
📒 Files selected for processing (1)
docs/snippets/cli-commands-deploy.mdx
Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review.
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
- GitHub Check: code-quality / code-quality
- GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
📓 Path-based instructions (2)
Add crumbs as you write code — not just when debugging. Mark lines with
📄 CodeRabbit inference engine (AGENTS.md)
Files:
docs/snippets/cli-commands-deploy.mdx
MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
📄 CodeRabbit inference engine (docs/CLAUDE.md)
Files:
docs/snippets/cli-commands-deploy.mdx
🔇 Additional comments (1)
docs/snippets/cli-commands-deploy.mdx (1)
124-127: LGTM!
Refreshes deployment-related docs.