Skip to content

docs: deploy build path flags and config file auto-detection - #4858

Merged
myftija merged 2 commits into
mainfrom
docs/deploy-build-paths
Sep 1, 2026
Merged

docs: deploy build path flags and config file auto-detection#4858
myftija merged 2 commits into
mainfrom
docs/deploy-build-paths

Conversation

@myftija

@myftija myftija commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

Refreshes deployment-related docs.

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.
@changeset-bot

changeset-bot Bot commented Sep 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 7d1a662

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The 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 --native-build for resource_exhausted errors.

Merge Risk: 🔵 Low · up to 7d1a6

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)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is relevant but largely incomplete. It does not include the required issue reference, checklist, testing details, changelog, or screenshots sections. Complete the repository template. Add the issue reference, checklist, testing steps and results, changelog entry, and screenshots section. Mark each checklist item accurately.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation changes: deploy build flags and configuration file auto-detection.
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 0…
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.
Full details: Docstring Coverage

Explanation

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.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/deploy-build-paths

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.

devin-ai-integration[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

@coderabbitai coderabbitai 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.

Actionable comments posted: 2


ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Team

Run ID: c8eabf95-15d3-40e7-8261-bbbf4a6e8000

📥 Commits

Reviewing files that changed from the base of the PR and between a1bb5a5 and 7d1a662.

📒 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!

Comment thread docs/snippets/cli-commands-deploy.mdx
Comment thread docs/snippets/cli-commands-deploy.mdx
@myftija
myftija merged commit 8142a11 into main Sep 1, 2026
28 checks passed
@myftija
myftija deleted the docs/deploy-build-paths branch September 1, 2026 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants