Shorebird release build for ios fails

[AnaNedicGithub]

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

If I run shorebird release ios from my console, I can get an .ipa file and upload it successfully to TestFlight using Xcode.

However, If I run run Release iOS Workflow from my project via codemagic, it fails.

If needed, I can provide any file from my project. Thank you!

Codemagic.yaml

definitions:
# Reusable definitions go in this section
scripts:
  - &shorebird_install
    name: Install Shorebird CLI
    script: |
      # Install the Shorebird CLI
      curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash
      # Set Shorebird PATH
      echo PATH="/Users/builder/.shorebird/bin:$PATH" >> $CM_ENV
  # - &flutter_analyze
  #   name: Run static code analysis
  #   script: flutter analyze
  - &setup_local_properties
    name: Set up local.properties
    script: echo "flutter.sdk=$HOME/programs/flutter" > "$CM_BUILD_DIR/android/local.properties"


workflows:
  # Define your workflows here
  release-android-workflow:
... # android workflow is ok

  release-ios-workflow:
    name: Release iOS Workflow
    integrations:
      app_store_connect: CodemagicCICDAPIKey
    environment:
      ios_signing:
        distribution_type: app_store
        bundle_identifier: com.semdatex.more-app
      groups:
        - shorebird_credentials
      vars:
        APP_STORE_APPLE_ID: 6596759542
      flutter: 3.22.3  #same as locally
      xcode: 15.3
    scripts:
      - name: Set up code signing settings on Xcode project
        script: |
          xcode-project use-profiles
      - name: Install pods
        script: |
          find . -name "Podfile" -execdir pod install \;
      - name: Flutter unit tests
        script: |
          flutter test
        ignore_failure: true
      - *shorebird_install
      - name: BuildWithShorebird
        script: |
          shorebird release ios --verbose -- \
            --build-name=1.0.0 \
            --build-number=$(($(app-store-connect get-latest-app-store-build-number "$APP_STORE_APPLE_ID") + 1)) \
            --export-options-plist=/Users/builder/export_options.plist
    artifacts:
      - build/ios/ipa/*.ipa
      - /tmp/xcodebuild_logs/*.log
      - flutter_drive.log
    publishing:
      email:
        recipients:
          - [email protected]
        notify:
          success: true
          failure: false
      app_store_connect:
        auth: integration
        submit_to_testflight: true
        submit_to_app_store: false

Expected results

App uploaded to TestFlight

Actual results

`: Writing 99941 characters to text file /Users/builder/.pub-cache/log/pub_log.txt.
[ +2 ms] Encountered error while archiving for device.
[ ]
#0 throwToolExit (package:flutter_tools/src/base/common.dart:10:3)
#1 _BuildIOSSubCommand.runCommand (package:flutter_tools/src/commands/build_ios.dart:691:7)

#2 BuildIOSArchiveCommand.runCommand (package:flutter_tools/src/commands/build_ios.dart:426:50)

#3 FlutterCommand.run. (package:flutter_tools/src/runner/flutter_command.dart:1394:27)

#4 AppContext.run. (package:flutter_tools/src/base/context.dart:153:19)

#5 CommandRunner.runCommand (package:args/command_runner.dart:212:13)

#6 FlutterCommandRunner.runCommand. (package:flutter_tools/src/runner/flutter_command_runner.dart:372:9)

#7 AppContext.run. (package:flutter_tools/src/base/context.dart:153:19)

#8 FlutterCommandRunner.runCommand (package:flutter_tools/src/runner/flutter_command_runner.dart:308:5)

#9 run.. (package:flutter_tools/runner.dart:130:9)

#10 AppContext.run. (package:flutter_tools/src/base/context.dart:153:19)

#11 main (package:flutter_tools/executable.dart:93:3)

(126.8s)
[Process.run] git symbolic-ref HEAD (in /Users/builder/.shorebird/bin/cache)
Exited with code 0

stdout:
refs/heads/stable

[Process.run] git rev-parse --verify HEAD (in /Users/builder/.shorebird/bin/cache)
Exited with code 0

stdout:
d0a36bc6eff29623f1101746cb0c43ab246d0c21

[Process.run] git remote prune origin (in /Users/builder/.shorebird/bin/cache)
Exited with code 0
[Process.run] git fetch --tags (in /Users/builder/.shorebird/bin/cache)
Exited with code 0
[Process.run] git rev-parse --verify @{upstream} (in /Users/builder/.shorebird/bin/cache)
Exited with code 0

stdout:
d0a36bc6eff29623f1101746cb0c43ab246d0c21

Build failed :|
Step 8 script BuildWithShorebird exited with status code 70`

Build id (optional)

66afbf0c93766dfdccfaa3ee

[dam-ease]

Hello @AnaNedicGithub.
I can see some error logs in your pod install step:

[!] Invalid `Podfile` file: /Users/builder/clone/ios/Flutter/Generated.xcconfig must exist. If you're running pod install manually, make sure flutter pub get is executed first.

 #  from /Users/builder/clone/ios/Podfile:16
 #  -------------------------------------------
 #    unless File.exist?(generated_xcode_build_settings_path)
 >      raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first"
 #    end
 #  -------------------------------------------

Can you add the below script in your yaml file, rerun the build and share the new build id with me.

cd ios
rm -rf Podfile.lock
flutter clean
flutter pub get
pod install
pod repo update

[AnaNedicGithub]

I tried 2 things: I removed pod install step, because I am building eith Shorebird so that may be enough. Build failed, id is 66b2358c55f5f45ce12fa133
After that, I added step you suggested to my codemagic.yaml. Build failed, id is: 66b23858b4855ff0d476a5c7

My codemagic.yaml:

definitions:
# Reusable definitions go in this section
scripts:
  - &shorebird_install
    name: Install Shorebird CLI
    script: |
      # Install the Shorebird CLI
      curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash
      # Set Shorebird PATH
      echo PATH="/Users/builder/.shorebird/bin:$PATH" >> $CM_ENV
  # - &flutter_analyze
  #   name: Run static code analysis
  #   script: flutter analyze
  - &setup_local_properties
    name: Set up local.properties
    script: echo "flutter.sdk=$HOME/programs/flutter" > "$CM_BUILD_DIR/android/local.properties"


workflows:
  # Define your workflows here
 
  release-ios-workflow:
    name: Release iOS Workflow
    integrations:
      app_store_connect: CodemagicCICDAPIKey
    environment:
      ios_signing:
        distribution_type: app_store
        bundle_identifier: com.semdatex.more-app
      groups:
        - shorebird_credentials
      vars:
        APP_STORE_APPLE_ID: 6596759542
      flutter: 3.22.3  #stable is an option
      xcode: 15.3
    scripts:
      - name: Set up code signing settings on Xcode project
        script: |
          xcode-project use-profiles
      - name: Update pods and get Flutter packages
        script: |
                cd ios
                rm -rf Podfile.lock
                flutter clean
                flutter pub get
                pod install
                pod repo update
      - name: Flutter unit tests
        script: |
          flutter test
        ignore_failure: true
      - *shorebird_install
      - name: BuildWithShorebird
        script: |
          shorebird release ios --verbose -- \
            --build-name=1.0.0 \
            --build-number=17 \
            --export-options-plist=/Users/builder/export_options.plist
    artifacts:
      - build/ios/ipa/*.ipa
      - /tmp/xcodebuild_logs/*.log
      - flutter_drive.log
    publishing:
      email:
        recipients:
          - [email protected]
        notify:
          success: true
          failure: false
      app_store_connect:
        auth: integration
        # Configuration related to TestFlight (optional)
        # Note: This action is performed during post-processing.
        submit_to_testflight: true
        #        beta_groups: # Specify the names of beta tester groups that will get access to the build once it has passed beta review.
        #          - group name 1
        #          - group name 2
        # Configuration related to App Store (optional)
        # Note: This action is performed during post-processing.
        submit_to_app_store: false

Thank you!

[dam-ease]

Hello @AnaNedicGithub,
I see you are running into a new error now.

"NSLocalizedFailureReason": "Failed to authenticate for session: (\n "Error Domain=ITunesConnectionAuthenticationErrorDomain Code=-26000 \"Failure to authenticate.\" UserInfo={NSLocalizedRecoverySuggestion=Failure to authenticate., NSLocalizedDescription=Failure to authenticate., NSLocalizedFailureReason=App Store operation failed.}"\n)"

What permission level have you assigned to the App Store Connect API key. It needs to have either the "App Manager" or "Admin" permission level. Can you please check this?

[AnaNedicGithub]

Hi @dam-ease , it seems ios build is ok now. The issue was indeed App Store Connect API key. It had the wrong issuer id. I left the "App manager" permission level, because I figured the error was due to the wrong issuer id.

I can see my build in the App Store, but the App Store Distribution post-processing step is marked red in the pipeline. Is this normal? Build id is 66b39c505cdb450db3196437

[dam-ease]

Hello,
For this, App Store Connect has finished processing your build and if you expand the step to check the logs, you'll see that the failure is due to incomplete test information required by Apple for TestFlight beta review.

Failure: Complete test information is required to submit application MoRe Medical App build for external testing.
App is missing required Beta App Information: Feedback Email.
App is missing required Beta App Review Information: First Name, Last Name, Phone Number, Email.
Fill in test information at https://appstoreconnect.apple.com/apps/6596759542/testflight/test-info.

To resolve this, you'll need to fill in the missing test information for your application on the TestFlight test info page in App Store Connect. You can follow the link above.

[AnaNedicGithub]

Hi @dam-ease , thank you for your ongoing support! I would appreciate your help with following 2 questions.

Firstly, I did what you said. Now my App Store Connect Distribution step fails with "Build is missing export compliance.". I can easily fix it manually in the TestFlight. Build id is 66b4e076d017a070ee685d27. Is there a way to automate this in Codemagic, and is it an issue if I leave the pipeline like this?

Second, I also need to patch ios release using Shorebird. I've fixed compliance issue manually and started shorebird build. It unfortunately failed, build id is 66b4e71415d999f5f08e2f96. It says "
✗ Failed to build IPA (98.7s)
Failed to build:
No Accounts
No profiles for 'com.semdatex.more-app' were found
[Process.run] git symbolic-ref HEAD (in /Users/builder/.shorebird/bin/cache)"
but i don't see how to fix it, I use the same values as for the ios workflow for the release. Could you please give me some more details?

[dam-ease]

Hello,
Thanks for your response.

1. You don't need to worry but you can fix this by modifying your info.plist file and adding

​<key>ITSAppUsesNonExemptEncryption</key>
<false/>

2. Please can you add --export-options-plist=/Users/builder/export_options.plist to your command:

shorebird patch ios  --verbose --release-version 1.0.1+4 --export-options-plist=/Users/builder/export_options.plist

[AnaNedicGithub]

Hi @dam-ease ,

I added script: shorebird patch ios --verbose --release-version 1.0.1+5 --export-options-plist=/Users/builder/export_options.plist to my codemagic.yaml, and this is the build number: 66b9db32863a114583f83f04.

Build failed, I can only see this issue, but maybe you can see more in the logs:

Export options plist /Users/builder/export_options.plist does not set manageAppVersionAndBuildNumber to false. This is required for shorebird to work.

Could you please clarify for me: is /Users/builder/... a folder on the machine that runs my pipeline?
Could you also please help with setting manageAppVersionAndBuildNumber to false? I could re-run the pipeline then.

[AnaNedicGithub]

Hi @dam-ease , thank you for your support - my build works now!

Could you please just answer two questions before closing the topic?

1. in failed builds, I was getting messages such as "Please include the following log file in your report:
   /Users/builder/Library/Application Support/shorebird/logs/1722333317349_shorebird.log"

Is this file is on the build machine running my workflow and can I access it?

2. Can I switch to the team account and keep all the setup I have made?

[dam-ease]

Hello @AnaNedicGithub

1. You can echo the content of the file during your build process by adding this to your script or try to include it as an artifact which you can download after the build.
2. Do you mean converting your personal account to a Team account? Yes, once you create a team you can share the app from your personal account to that team account. All of your variables will be transferred with your app as well.

[AnaNedicGithub]

Hi @dam-ease,

Thank you for the response. Could you please tell me what to add to the build script to include logs from the build machine as an artifact I can download after the build?

I would add it to all my workflows, for Android and iOS as well.

[dam-ease]

Hello @AnaNedicGithub.
Please try adding this to your script:

scripts:
 - name: Build AAB with Flutter
        script: |
          BUILD_NUMBER=$(($(google-play get-latest-build-number --package-name "$PACKAGE_NAME" --tracks="$GOOGLE_PLAY_TRACK") + 1))      
          flutter build appbundle --release \
            --build-name=1.0.$BUILD_NUMBER \
            --build-number=$BUILD_NUMBER
          mkdir -p /tmp/logs
          cp /Users/builder/Library/Application\ Support/shorebird/logs/*.log /tmp/logs/

artifacts:
  - /tmp/logs/*.log

[dtrdic]

Ana, let Damilola know by replying to this thread if you have any other questions. Closing it for now due to inactivity.