White labeling

[zs-dima]

If you are looking for help, please confirm the following...

• I confirm I have searched the Docs, Codemagic Sample Projects, and GitHub Discussions.
• I confirm the software versions on my local computer match the ones in CI environment (e.g. Xcode version, Gradle version). See here
• I confirm I am able to do a fresh clone of the repository and build the project on my local computer.

Which mobile framework are you using?

Flutter (Dart)

Steps to reproduce

1. Create provisioning profiles for each brand and device type:
   brand1_provisioning_profile: iOS Brand1 com.company1.bundle;
   brand2_provisioning_profile: iOS Brand2 com.company2.bundle;
   brand1_tv_provisioning_profile: tvOS Brand1 com.company1.bundle;
   brand2_tv_provisioning_profile: tvOS Brand2 com.company2.bundle;

2. Reference provisioning profiles in the codemagic.yaml workflow:
   provisioning_profiles:
   - profile: brand1_tv_provisioning_profile_ref
   - profile: brand2_tv_provisioning_profile_ref
   - profile: brand1_provisioning_profile_ref
   - profile: brand2_provisioning_profile_ref

3. Update bundle ID according to $BUNDLE_ID environment variable, and check the result using grep:
   script: |
   PBXPROJ=$CM_BUILD_DIR/ios/Runner.xcodeproj/project.pbxproj
   sed -i '' "s/$BASE_BUNDLE_ID/$BUNDLE_ID/g" $PBXPROJ
   grep "PRODUCT_BUNDLE_IDENTIFIER" $PBXPROJ

4. Run build for Brand2 iOS

5. Failed to build iOS app
   Error (Xcode): Provisioning profile "fomo_app_tv_provisioning_profile" has platform "tvOS", which does not match the current platform "iOS".
   /Users/builder/clone/ios/Runner.xcodeproj

Expected results

Codemagic has to select the provisioning profile using bundle ID AND Device Type. (not only by bundle ID)
so brand1_provisioning_profile_ref has to be selected for the case above instead of brand1_tv_provisioning_profile_ref.

Actual results

Failed to build iOS app
Error (Xcode): Provisioning profile "brand2_tv_provisioning_profile_ref" has platform "tvOS", which does not match the current platform "iOS".
/Users/builder/clone/ios/Runner.xcodeproj

Build id (optional)

No response

[dtrdic]

hello @zs-dima Instead of manually creating and referencing provisioning profiles in Codemagic, you can allow Codemagic to automatically handle fetching and applying the correct provisioning profiles for your app.

The key command responsible for this is:
app-store-connect fetch-signing-files "$BUNDLE_ID" --type IOS_APP_STORE --create
This command fetches the provisioning profile and certificate for the specified BUNDLE_ID from App Store Connect. It ensures that the provisioning profile for the iOS App Store distribution is used. By adding the --create flag, it will automatically create a provisioning profile if one does not already exist.

Since you are whitelabeling let me share this guide with you, which will help you on setting up all the required steps for whitelabeling your apps.
Also please share a build id in the future so we can check your configuration and suggest you accordingly

[zs-dima]

@dtrdic thanks a lot for the answer
Sure I saw guides and documentation.

If I do not provide provisioning profiles it is error message:

1 validation error in codemagic.yaml:
ios-workflow -> environment -> ios_signing ->
  Either distribution profile and bundle identifier or provisioning profiles (and optionally certificates) must be provided.

If I provide only one provisioning profile it is error:

No development certificates available to code sign app for device deployment

I prefer to use integrations instead of manual keychain management as in your example:

    integrations:
      app_store_connect: app_appstore_api_key
    environment:
      ios_signing:
        certificates:
          - app_apple_signing_certificate
    scripts:
      - *call_scripts
      - name: Set up code signing
        script: |
          app-store-connect fetch-signing-files "$BUNDLE_ID" --type IOS_APP_STORE --create
          xcode-project use-profiles          

[dtrdic]

@zs-dima you won't be able to use the App Store Connect integration in this case. You'll need to take a different approach by manually defining the App Store Connect API key information (e.g., APP_STORE_CONNECT_KEY_IDENTIFIER, APP_STORE_CONNECT_ISSUER_ID, APP_STORE_CONNECT_PRIVATE_KEY) as environment variables and adding them to Codemagic.

So remove this part

integrations:
   app_store_connect: app_appstore_api_key
 environment:
   ios_signing:
     certificates:
       - app_apple_signing_certificate

Add the required environment variables to Codemagic: You can set them in the Codemagic UI as shown below:

And reference the variables through the group name in your codemagic.yaml

    environment:
      groups:
        - client_001

also remove app store integration from publishing section and use variables

    artifacts: 
      - build/ios/ipa/*.ipa
    publishing:      
      app_store_connect:
        api_key: $APP_STORE_CONNECT_PRIVATE_KEY
        key_id: $APP_STORE_CONNECT_KEY_IDENTIFIER
        issuer_id: $APP_STORE_CONNECT_ISSUER_ID

[zs-dima]

@dtrdic thanks a lot, environment variables work well, although it would be nice to automate it a bit. As we already have integration, codemagic can handle most of these automatically.
Especially when documentation is not very precise:
https://docs.codemagic.io/yaml-code-signing/alternative-code-signing-methods/

When prompted for the import password, just press enter.

• you have to enter the key password instead for example.

https://github.com/codemagic-ci-cd/white-label-demo-project/blob/main/codemagic.yaml

sed -i '' -e 's/PRODUCT_BUNDLE_IDENTIFIER = [^\;]*;/PRODUCT_BUNDLE_IDENTIFIER = '${BUNDLE_ID}';/' ios/${XCODE_SCHEME}.xcodeproj/project.pbxproj

• it will remove ".RunnerTests" for the: com.company1.bundle.RunnerTests;