Skip to content

Commit 4c9e4dd

Browse files
committed
feat(readme): update readme with build requirements and additional troubleshooting
1 parent 7f54041 commit 4c9e4dd

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ _Questions? [Contact us](https://support.branch.io/support/tickets/new)_
5555
* [Compiling: Updating the Branch SDK](#compiling-updating-the-branch-sdk)
5656
* [Compiling: Incompatible Plugins](#compiling-incompatible-plugins)
5757
* [Compiling: Errors](#compiling-errors)
58+
* [Compiling: Capacitor](#compiling-capacitor)
59+
* [AppStore: iOS](#appstore-ios)
5860

5961
## Getting Started
6062

@@ -1348,3 +1350,59 @@ _Questions? [Contact us](https://support.branch.io/support/tickets/new)_
13481350
```
13491351
13501352
* Add `<preference name="android-minSdkVersion" value="16" />` to your `config.xml`
1353+
1354+
* error
1355+
1356+
```sh
1357+
Branch.h not found
1358+
```
1359+
If that is the ONLY error you see, this can be fixed by upgrading dependencies.
1360+
Ensure you are using version 4.0.1 of this plugin or higher and have updated your Xcode, Cordova, and other dependencies (listed below) to the latest versions. This error arose due to an inability in CocoaPods and cordova-ios to resolve dependencies that was later fixed.
1361+
1362+
Sometimes this error occurs when a build error occurs in the Pod project; since Branch is usually the first pod alphabetically, it'll show up as the error when attempting to build the main project (since the Pod didn't get built), even though the real error is elsewhere. Make sure to read your build log to find the original error that prevented building the Pod project.
1363+
1364+
* error: ios build fails with Pods and CONFIGURATION_BUILD_DIR configured
1365+
1366+
Command-line builds result in the above error. Please see the section below [Compiling: Capacitor](#compiling-capacitor) for the full list of up-to-date dependencies needed for CLI builds to work.
1367+
1368+
* #### Compiling: Capacitor
1369+
1370+
* ##### Version 4.0.1 of this plugin works with Ionic 4 + Cordova and Ionic 4 + Capacitor, with the following caveats:
1371+
1372+
* We strongly recommend Node >= 10.15. Node 8 might work, but it is not tested.
1373+
* For BOTH Cordova and Capacitor, you must use Xcode >= 11.1, CocoaPods >= 1.8.4, Cordova >= 9.0.0, Ionic-CLI >= 5.1, cordova-ios >= 5.1.0
1374+
* Every single one of these dependencies has fixes that allow the command line build, and the pod dependency resolution to work correctly
1375+
* When using Capacitor, you must add the following entries yourself to `ios/App/App/Info.plist`:
1376+
```sh
1377+
<key>CFBundleURLTypes</key>
1378+
<array>
1379+
<dict>
1380+
<key>CFBundleURLName</key>
1381+
<string>com.getcapacitor.capacitor</string>
1382+
<key>CFBundleURLSchemes</key>
1383+
<array>
1384+
<string>capacitor</string>
1385+
</array>
1386+
</dict>
1387+
<dict>
1388+
<key>CFBundleURLName</key>
1389+
<string>branch-cordova-sdk</string>
1390+
<key>CFBundleURLSchemes</key>
1391+
<array>
1392+
<string>[YOUR URL SCHEME HERE]</string>
1393+
</array>
1394+
</dict>
1395+
</array>
1396+
<key>branch_key</key>
1397+
<string>[YOUR BRANCH LIVE KEY]</string>
1398+
<key>branch_app_domain</key>
1399+
<string>[YOUR DOMAIN].app.link</string>
1400+
```
1401+
* When using Capacitor, you must add your Associated Domains entitlements via the Xcode entitlement editor yourself
1402+
* This MUST be done using Xcode - this is part of Capacitor's philosophy whereby you are in control of every config file change
1403+
* Open the "Signing & Entitlements" tab in Xcode, add the Associated Domains entitlement, and add the urls found on your Branch dashboard.
1404+
1405+
* #### AppStore: iOS
1406+
1407+
* #### App rejected because it uses push notification features but does not declare the aps-environment key
1408+
When branch-cordova-sdk moved to use CocoaPods, a change was introduced in Cordova 9 where the separate entitlement files were no longer flattened together. This issue has been fixed in version 4.0.1 of this plugin.

0 commit comments

Comments
 (0)