Skip to content

Commit

Permalink
SDK-1329 restore readme. move xcode scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
echo-branch committed Oct 18, 2022
1 parent 4abf00d commit 8b5711e
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 51 deletions.
46 changes: 1 addition & 45 deletions Branch-TestBed/README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,2 @@
# Create a personal copy of Branch's Objective-C TestBed app for testing!
Legacy Branch TestBed - used to run older unit tests

1. From the command line:
- Clone the repo: `git clone git@github.com:BranchMetrics/ios-branch-deep-linking.git`
2. In Finder open: **Branch-TestBed.xcodeproj**
3. In Xcode click on the root node of the project: Branch-TestBed
4. Under Targets select Branch-TestBed, then the General tab
5. Change the Bundle Identifier to something **unique** (for this demo we'll use `io.branch.Objective-C.TestBed`)
6. Change the Team to your Team (it must be a *paid* Apple Developer Account) and click **Fix Issue** to generate a new Provisioning Profile
7. Log in to the [Branch dashboard](https://dashboard.branch.io) and create a new app from the drop-down menu in the top right corner
8. On the Settings, screen copy the Branch key
9. In the Xcode project's **info.plist** file, change the `branch_key` entry to the value of your new Branch key key
10. Populate the Branch dashboard with the following values:
- Always try to open app: Checked
- I have an iOS App: Checked
- iOS URL: `branchtest://` (from the **Supporting Files/Branch-TestBed-Info.plist** file, this is URL Types > URL Schemes > Item 0)
- Custom URL: (enter a web site here if you haven't published the app to the App Store - http://www.branch.io, for example)
- Default URL: (any web site will do: http://www.branch.io, for example)

## Set up Universal Links

> **NOTE:** these steps will not work if you do not have a *paid* Apple Developer Account
1. In the **Branch-TestBed.entitlements** file, add entries for the new Branch Live and Test link domains. For example:
- **applinks:xxxx.app.link**
- **applinks:xxxx.test-app.link**
- **applinks:xxxx-alternate.app.link**
- **applinks:xxxx-alternate.test-app.link**
2. Run the app and make sure that it launches properly on a device or on a simulator
3. Select the **Branch-TestBed.entitlements** file and ensure the **Branch-TestBed** box is checked inside Target Membership
4. Populate the Branch dashboard with the following values:
- Enable Universal Links: checked
- Bundle Identifier: as set in the project above
- Apple App Prefix: (find this in the Apple developer dashboard: https://developer.apple.com/account/ios/identifier/bundle)
4. Save the settings - you are done!

### Test
1. If the app was installed on the test device already:
- Delete the app from the device
- Clear Safari web content, history and cookies (Settings > Safari > Clear History and Website Data)
- Reset the device's IDFA (Settings > Privacy > Advertising > Reset Advertising Identifier...)
2. Create a Marketing link from the Branch dashboard
3. Paste the link into Notes on an iPhone
4. Tap the link - you will get redirected to the web page
5. Install the app on the device via Xcode
6. Tapping on the link should now open the app directly
8 changes: 4 additions & 4 deletions BranchSDK.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -1533,7 +1533,7 @@
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "# Type a script or drag a script file from your workspace to insert its path.\nScripts/build_xcframework.sh\n";
shellScript = "# Type a script or drag a script file from your workspace to insert its path.\nscripts/xcode/build_xcframework.sh\n";
};
5FF9DEF828EE801400D62DE1 /* ShellScript */ = {
isa = PBXShellScriptBuildPhase;
Expand All @@ -1551,7 +1551,7 @@
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "# Type a script or drag a script file from your workspace to insert its path.\nScripts/build_xcframework_noidfa.sh\n";
shellScript = "# Type a script or drag a script file from your workspace to insert its path.\nscripts/xcode/build_xcframework_noidfa.sh\n";
};
5FF9DEF928EE804900D62DE1 /* ShellScript */ = {
isa = PBXShellScriptBuildPhase;
Expand All @@ -1569,7 +1569,7 @@
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "# Type a script or drag a script file from your workspace to insert its path.\nScripts/build_static_xcframework.sh\n";
shellScript = "# Type a script or drag a script file from your workspace to insert its path.\nscripts/xcode/build_static_xcframework.sh\n";
};
5FF9DEFA28EE805C00D62DE1 /* ShellScript */ = {
isa = PBXShellScriptBuildPhase;
Expand All @@ -1587,7 +1587,7 @@
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "# Type a script or drag a script file from your workspace to insert its path.\nScripts/build_static_xcframework_noidfa.sh\n";
shellScript = "# Type a script or drag a script file from your workspace to insert its path.\nscripts/xcode/build_static_xcframework_noidfa.sh\n";
};
/* End PBXShellScriptBuildPhase section */

Expand Down
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# iOSScratch
Save major refactor progress
# Branch SDK Documentation for iOS

The Branch iOS SDK for deep linking and attribution.

> ## Branch Sandbox Program
>
> As part of this [sandbox program](https://help.branch.io/developers-hub/docs/branch-sandbox-program), you will be able to partner directly with Branch’s Product and Engineering team for exclusive access to test drive our innovative products before the market and proactively exchange valuable feedback. With your support, we will create the winning measurement and linking solutions of the future together.
>
> **If you would like to join, please reach out to us today at [sandbox@branch.io](mailto:sandbox@branch.io "mailto:sandbox@branch.io") or by filling out this [form](https://branch.link/sandbox?~channel=ios-repo).**
Branch helps mobile apps grow with deep links / deeplinks that power paid acquisition and re-engagement campaigns, referral programs, content sharing, deep linked emails, smart banners, custom user onboarding, and more.

View [Branch's SDK documentation for iOS](https://help.branch.io/developers-hub/docs/ios-sdk-overview)
Empty file modified scripts/annouce_sdk_release.sh
100755 → 100644
Empty file.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 8b5711e

Please sign in to comment.