Skip to content

docs: iOS multi-target signing documentation#502

Merged
WcaleNieWolny merged 4 commits intomainfrom
feat/ios-multi-target-signing-docs
Mar 2, 2026
Merged

docs: iOS multi-target signing documentation#502
WcaleNieWolny merged 4 commits intomainfrom
feat/ios-multi-target-signing-docs

Conversation

@WcaleNieWolny
Copy link
Contributor

@WcaleNieWolny WcaleNieWolny commented Feb 27, 2026

Summary

  • Update credentials.mdx: replace old profile flags/env vars with --ios-provisioning-profile and CAPGO_IOS_PROVISIONING_MAP
  • Update ios.mdx: replace old profile flags, add "Apps with Extensions" section
  • Add migration instructions for build credentials migrate --platform ios
  • Update CI/CD examples (GitHub Actions) with new env vars

Related PRs

  • CLI: Cap-go/CLI (feat/ios-multi-target-signing)
  • Builder: Cap-go/capgo_builder (feat/ios-multi-target-signing)

Test plan

  • Review docs for accuracy against CLI implementation
  • Verify all code examples use correct flag names
  • Check that migration instructions are clear

Summary by CodeRabbit

  • Documentation
    • Added Update Credentials flow with provisioning profile merge capabilities
    • Added Migrate Credentials command to convert legacy provisioning formats
    • Enhanced credential management options for listing and clearing per app and platform
    • Introduced new iOS CLI flags for build output control and version management
    • Documented multi-target provisioning support for extensions
    • Updated provisioning map references and migration guidance for workflows

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 27, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd8ea4a and 97d9f54.

📒 Files selected for processing (2)
  • src/content/docs/docs/cli/cloud-build/credentials.mdx
  • src/content/docs/docs/cli/cloud-build/ios.mdx

📝 Walkthrough

Walkthrough

This pull request updates iOS cloud build documentation to introduce a new multi-target provisioning profile mapping system. It replaces legacy single-profile CLI flags and environment variables with modern CAPGO_IOS_PROVISIONING_MAP support, adds new credential management flows including update and migrate commands, and documents support for multiple targets (app and extensions).

Changes

Cohort / File(s) Summary
iOS Credentials Management
src/content/docs/docs/cli/cloud-build/credentials.mdx
Adds Update and Migrate Credentials flows; replaces BUILD_PROVISION_PROFILE_BASE64 with CAPGO_IOS_PROVISIONING_MAP; documents migration from legacy single-profile format; updates saved credentials JSON structure and environment variable guidance.
iOS Build Configuration
src/content/docs/docs/cli/cloud-build/ios.mdx
Replaces --provisioning-profile and --apple-profile-name with repeatable --ios-provisioning-profile flag; documents multi-target provisioning for app and extensions; adds new iOS CLI flags (--output-upload, --output-retention, --skip-build-number-bump); updates examples and migration guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 Hop into the future, profiles are mapped!
Multi-targets dance, no more single-snap.
Legacy keys fade to the pasture green,
The cleanest provisioning we've ever seen!
Extensions and apps in harmony unified,

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/ios-multi-target-signing-docs

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.

- Document `build credentials update` with additive merge and
  `--overwrite-ios-provisioning-map`
- Document `build credentials migrate` command in Commands section
- Add `--output-upload`, `--output-retention`, `--skip-build-number-bump`
  to iOS options table
- Replace stale `--apple-id`/`--apple-app-password` (not in CLI)
- Update API key note: not required when output-upload or skip-bump set
- Fix multi-target migration to use `update` instead of `save`
- Clarify migrate removes legacy keys (BUILD_PROVISION_PROFILE_BASE64,
  APPLE_PROFILE_NAME)
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 2, 2026

@WcaleNieWolny WcaleNieWolny marked this pull request as ready for review March 2, 2026 05:19
@WcaleNieWolny WcaleNieWolny merged commit 59ba28f into main Mar 2, 2026
6 checks passed
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 97d9f54daa

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


<Aside type="note" title="¹ App Store Connect API Key Requirements">
- **`app_store` mode** (default): All three options are **required** — they are used to upload your build to TestFlight / App Store.
- **`app_store` mode** (default): All three API key options are **required** unless you pass `--output-upload` or `--skip-build-number-bump` (which bypass the need for API-driven submission).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Correct app_store API-key exception guidance

This note says --skip-build-number-bump removes the need for App Store Connect API keys in app_store mode, but that flag only controls build-number incrementing and does not switch off App Store submission; users following this guidance can omit --apple-key* credentials and hit signing/submission failures. The surrounding docs already frame “no API key” as an ad-hoc flow (see ios.mdx ad-hoc section), so this exception should be limited to scenarios that truly avoid store submission.

Useful? React with 👍 / 👎.

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.

1 participant