docs: add Cloud Build Configuration Options reference page#497
docs: add Cloud Build Configuration Options reference page#497WcaleNieWolny merged 8 commits intomainfrom
Conversation
New page documents all CLI flags, environment variables, and credential keys for cloud builds. Includes configuration precedence, CI/CD examples, and environment variable quick reference for copy-paste into pipelines.
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR adds comprehensive Cloud Build configuration documentation and reorders existing documentation pages. The main addition is a new configuration reference page containing CLI flags, environment variables, credential keys, and configuration precedence information. Sidebar order values are updated across four existing documentation pages to accommodate the new page's insertion. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
…l-only vars - Add Credential Key column to iOS Build Settings (CAPGO_IOS_SCHEME, CAPGO_IOS_TARGET) - Remove CAPGO_IOS_SOURCE_DIR and CAPGO_ANDROID_SOURCE_DIR (auto-detected, not user-configurable) - Remove from env var quick reference sections too
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Pull request overview
Adds a new Cloud Build “Configuration Options” reference page intended to centralize CLI flags, environment variables, and credential keys, and adjusts the Cloud Build docs sidebar ordering to place it after Getting Started.
Changes:
- Added
Configuration Optionsreference page with precedence rules, option tables, quick env-var snippets, and examples (including GitHub Actions). - Updated Cloud Build section sidebar ordering to accommodate the new page.
- Introduced a Mermaid-based configuration precedence diagram.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/docs/docs/cli/cloud-build/configuration.mdx | New comprehensive reference page for Cloud Build configuration options and examples. |
| src/content/docs/docs/cli/cloud-build/ios.mdx | Sidebar order bump to make room for the new page. |
| src/content/docs/docs/cli/cloud-build/android.mdx | Sidebar order bump to make room for the new page. |
| src/content/docs/docs/cli/cloud-build/troubleshooting.mdx | Sidebar order bump to make room for the new page. |
| src/content/docs/docs/cli/cloud-build/credentials.mdx | Sidebar order bump to make room for the new page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Replace CAPGO_APIKEY with CAPGO_TOKEN throughout (matches CLI source) - Switch GitHub Actions example from npm/npx to Bun/bunx - Replace npx with bunx in all CLI examples - Use "Capgo Cloud Build" instead of "Capgo Build" for consistency - Remove unused Steps import
Keeps Env Variable column consistent with other tables (variable name only), moves the =true/=false usage hint into the Description column.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
src/content/docs/docs/cli/cloud-build/configuration.mdx (4)
124-128: Table formatting embeds values in column headers for--output-upload.Lines 126-127 show
BUILD_OUTPUT_UPLOAD_ENABLED=trueandBUILD_OUTPUT_UPLOAD_ENABLED=falsein the Env Variable column. This is atypical — other rows just list the variable name. Consider listing justBUILD_OUTPUT_UPLOAD_ENABLEDin the env var column and describing thetrue/falsesemantics in the Description column for consistency.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/docs/cli/cloud-build/configuration.mdx` around lines 124 - 128, The Env Variable column for the `--output-upload` and `--no-output-upload` rows currently embeds boolean examples; change those two cells to only show the variable name `BUILD_OUTPUT_UPLOAD_ENABLED` and move the `true`/`false` semantics into the Description column (e.g., for `--output-upload` note that `BUILD_OUTPUT_UPLOAD_ENABLED=true` enables upload and for `--no-output-upload` note that `BUILD_OUTPUT_UPLOAD_ENABLED=false` disables it), updating the rows that reference the CLI flags `--output-upload` and `--no-output-upload` and the env var `BUILD_OUTPUT_UPLOAD_ENABLED` accordingly to match the other rows' style.
256-301: Usebuninstead ofnpm/npxin examples.The GitHub Actions example uses
npm install(lines 270, 291) andnpx(lines 271-272, 292-293), but the project convention is to usebun. The existing ios.mdx and android.mdx CI examples consistently useoven-sh/setup-bunandbunx. This page should follow the same pattern for consistency.🧹 Proposed fix (iOS job shown; apply same pattern to Android job)
- uses: actions/checkout@v4 - - uses: actions/setup-node@v4 + - uses: oven-sh/setup-bun@v2 with: - node-version: 20 - - run: npm install - - run: npx cap sync ios - - run: npx `@capgo/cli` build request --platform ios + bun-version: latest + - run: bun install + - run: bunx cap sync ios + - run: bunx `@capgo/cli` build request --platform iosBased on learnings: "Always use
buninstead ofnpmoryarnfor package management (install, run scripts, add/remove packages)."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/docs/cli/cloud-build/configuration.mdx` around lines 256 - 301, Update the GitHub Actions jobs build-ios and build-android to use bun instead of npm/npx: replace uses: actions/setup-node@v4 with uses: oven-sh/setup-bun@v1 (or the repo's chosen bun action), change "npm install" to "bun install", and replace all "npx" invocations ("npx cap sync ios/android" and "npx `@capgo/cli` build request --platform ...") with "bunx" equivalents (e.g., "bunx cap sync ..." and "bunx `@capgo/cli` build request --platform ...") so both jobs follow the project's bun convention.
86-92: Android Build Settings table is missing CLI Flag and Credential Key columns.Every other options table in this document has CLI Flag, Env Variable, Credential Key, Default, and Description columns. This table only has Env Variable, Default, and Description — making it unclear whether these settings can also be passed via CLI flags or stored in credentials. If there truly are no CLI flags for these, a brief note explaining that would help.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/docs/cli/cloud-build/configuration.mdx` around lines 86 - 92, Update the "Android Build Settings" table to match the other options tables by adding the CLI Flag and Credential Key columns; for the two rows referencing PLAY_STORE_TRACK and PLAY_STORE_RELEASE_STATUS, either populate the CLI Flag column with the corresponding flags if they exist (e.g., --play-store-track, --play-store-release-status) and the Credential Key column with the credential keys used to store them, or explicitly state "none" or "N/A" in those columns if no CLI flags or credential keys exist; ensure the table header includes "CLI Flag" and "Credential Key" and that the rows for PLAY_STORE_TRACK and PLAY_STORE_RELEASE_STATUS reflect the chosen values or the brief note about absence.
9-9: UnusedStepsimport.
Stepsis imported but never used in this file. OnlyAsideandMermaidGraphare used.🧹 Proposed fix
-import { Aside, Steps } from '@astrojs/starlight/components'; +import { Aside } from '@astrojs/starlight/components';🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/docs/cli/cloud-build/configuration.mdx` at line 9, The import currently brings in an unused symbol Steps; update the import statement that references Aside and Steps to instead import the actual used components (Aside and MermaidGraph) from '@astrojs/starlight/components', removing Steps so there are no unused imports and the file uses the correct MermaidGraph symbol.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/docs/cli/cloud-build/configuration.mdx`:
- Around line 226-235: Pick the canonical storage behavior (recommendation:
default = global folder in user home `~/.capgo-credentials/`, optional `--local`
to create/use `.capgo-credentials.json` in project root) and update both docs to
match: edit the "Storage Locations" section in configuration.mdx to mention that
default is the home directory `~/.capgo-credentials/` and that `--local`
creates/uses `.capgo-credentials.json` in the project root, and edit
credentials.mdx (the ".capgo-credentials" description) to explicitly state the
same behavior (default = home folder only, project root only when `--local` is
used), ensuring the same wording about adding `.capgo-credentials.json` to
`.gitignore` and clarifying there is no automatic project-root fallback.
- Around line 243-244: Remove the invalid CLI example "npx `@capgo/cli` build
credentials update --skip-build-number-bump" from configuration.mdx and either
delete the line or replace it with a valid credentials command such as "npx
`@capgo/cli` build credentials save" or "npx `@capgo/cli` build credentials clear"
so the docs only show supported subcommands (save, list, clear).
---
Nitpick comments:
In `@src/content/docs/docs/cli/cloud-build/configuration.mdx`:
- Around line 124-128: The Env Variable column for the `--output-upload` and
`--no-output-upload` rows currently embeds boolean examples; change those two
cells to only show the variable name `BUILD_OUTPUT_UPLOAD_ENABLED` and move the
`true`/`false` semantics into the Description column (e.g., for
`--output-upload` note that `BUILD_OUTPUT_UPLOAD_ENABLED=true` enables upload
and for `--no-output-upload` note that `BUILD_OUTPUT_UPLOAD_ENABLED=false`
disables it), updating the rows that reference the CLI flags `--output-upload`
and `--no-output-upload` and the env var `BUILD_OUTPUT_UPLOAD_ENABLED`
accordingly to match the other rows' style.
- Around line 256-301: Update the GitHub Actions jobs build-ios and
build-android to use bun instead of npm/npx: replace uses: actions/setup-node@v4
with uses: oven-sh/setup-bun@v1 (or the repo's chosen bun action), change "npm
install" to "bun install", and replace all "npx" invocations ("npx cap sync
ios/android" and "npx `@capgo/cli` build request --platform ...") with "bunx"
equivalents (e.g., "bunx cap sync ..." and "bunx `@capgo/cli` build request
--platform ...") so both jobs follow the project's bun convention.
- Around line 86-92: Update the "Android Build Settings" table to match the
other options tables by adding the CLI Flag and Credential Key columns; for the
two rows referencing PLAY_STORE_TRACK and PLAY_STORE_RELEASE_STATUS, either
populate the CLI Flag column with the corresponding flags if they exist (e.g.,
--play-store-track, --play-store-release-status) and the Credential Key column
with the credential keys used to store them, or explicitly state "none" or "N/A"
in those columns if no CLI flags or credential keys exist; ensure the table
header includes "CLI Flag" and "Credential Key" and that the rows for
PLAY_STORE_TRACK and PLAY_STORE_RELEASE_STATUS reflect the chosen values or the
brief note about absence.
- Line 9: The import currently brings in an unused symbol Steps; update the
import statement that references Aside and Steps to instead import the actual
used components (Aside and MermaidGraph) from '@astrojs/starlight/components',
removing Steps so there are no unused imports and the file uses the correct
MermaidGraph symbol.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
src/content/docs/docs/cli/cloud-build/android.mdxsrc/content/docs/docs/cli/cloud-build/configuration.mdxsrc/content/docs/docs/cli/cloud-build/credentials.mdxsrc/content/docs/docs/cli/cloud-build/ios.mdxsrc/content/docs/docs/cli/cloud-build/troubleshooting.mdx
There was a problem hiding this comment.
♻️ Duplicate comments (2)
src/content/docs/docs/cli/cloud-build/configuration.mdx (2)
226-232:⚠️ Potential issue | 🟡 MinorKeep credential storage behavior wording consistent across pages.
Lines 230-232 define a strict model (default
~/.capgo-credentials/, project-root only with--local), but the credentials page still describes “project root or home directory,” which conflicts with this reference.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/docs/cli/cloud-build/configuration.mdx` around lines 226 - 232, The wording under "Storage Locations" is inconsistent with the credentials page: update the text so the behavior is described consistently across docs by explicitly stating the default global storage path (~/.capgo-credentials/) and that the --local flag writes a per-project file (.capgo-credentials.json in the project root); keep the same phrases and examples used on the credentials page to match its "project root or home directory" wording and ensure both pages mention the same default and override behavior for the --local flag.
243-244:⚠️ Potential issue | 🟠 MajorRemove unsupported
build credentials updateexample.Line 244 documents
build credentials update, but the command set shown in Cloud Build docs issave,list, andclear. This will lead users to a command-not-found flow.💡 Proposed doc fix
-# Update a specific option without re-entering everything -bunx `@capgo/cli` build credentials update --skip-build-number-bump +# Re-save credentials when values change +bunx `@capgo/cli` build credentials save --platform ios ...#!/bin/bash set -euo pipefail echo "Cloud Build docs: documented credentials subcommands" rg -nP 'build credentials (save|list|clear|update)\b' src/content/docs/docs/cli/cloud-build echo echo "Any CLI docs references to credentials update" fd -t f '.*\.mdx$' src/content/docs/docs | xargs -r rg -nP '\bcredentials update\b'Expected result:
credentials updateshould not appear if it is unsupported.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/docs/cli/cloud-build/configuration.mdx` around lines 243 - 244, Remove the unsupported example invoking "build credentials update" and replace it with a valid example using one of the supported subcommands (save, list, or clear); specifically locate the line containing the example command "bunx `@capgo/cli` build credentials update --skip-build-number-bump" in the Cloud Build docs and either delete it or change it to a correct command (for example "bunx `@capgo/cli` build credentials save ..." or "bunx `@capgo/cli` build credentials list") so the docs only show supported credentials subcommands.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@src/content/docs/docs/cli/cloud-build/configuration.mdx`:
- Around line 226-232: The wording under "Storage Locations" is inconsistent
with the credentials page: update the text so the behavior is described
consistently across docs by explicitly stating the default global storage path
(~/.capgo-credentials/) and that the --local flag writes a per-project file
(.capgo-credentials.json in the project root); keep the same phrases and
examples used on the credentials page to match its "project root or home
directory" wording and ensure both pages mention the same default and override
behavior for the --local flag.
- Around line 243-244: Remove the unsupported example invoking "build
credentials update" and replace it with a valid example using one of the
supported subcommands (save, list, or clear); specifically locate the line
containing the example command "bunx `@capgo/cli` build credentials update
--skip-build-number-bump" in the Cloud Build docs and either delete it or change
it to a correct command (for example "bunx `@capgo/cli` build credentials save
..." or "bunx `@capgo/cli` build credentials list") so the docs only show
supported credentials subcommands.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
src/content/docs/docs/cli/cloud-build/android.mdxsrc/content/docs/docs/cli/cloud-build/configuration.mdxsrc/content/docs/docs/cli/cloud-build/credentials.mdxsrc/content/docs/docs/cli/cloud-build/ios.mdxsrc/content/docs/docs/cli/cloud-build/troubleshooting.mdx
- Update Mermaid diagram to show CLI > env > local credentials > global credentials - Fix global storage path to ~/.capgo-credentials/credentials.json (not just the directory) - Clarify that local credentials override global when both exist
|
Summary
New page sections
Test plan
/docs/cli/cloud-build/configuration/Summary by CodeRabbit