Skip to content

Commit be3bc5f

Browse files
authored
Merge pull request #298 from BranchMetrics/native-sdk-install-script
Native sdk install script
2 parents a3b2143 + eaf5b5c commit be3bc5f

36 files changed

+149
-2152
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Developing the SDK Locally
2+
23
*Questions? [Contact us](https://support.branch.io/support/tickets/new)*
34

45
1. [Dependencies](#dependencies)
@@ -25,13 +26,13 @@ export PATH="/usr/local/bin:$PATH";
2526
2627
```sh
2728
brew install node;
28-
```
29+
```
2930

3031
> Gulp
3132
3233
```sh
3334
npm install -g gulp-cli;
34-
```
35+
```
3536

3637
### SDK
3738

@@ -46,73 +47,36 @@ npm install --save-dev;
4647

4748
### Develop
4849

49-
> Build
50+
> Changes to `/src` don't need a `init.sh` rebuild, just a `cordova run ios`
5051
51-
```sh
52-
gulp prerelease;
53-
```
54-
55-
> **[optional]** Update [iOS SDK](https://github.com/BranchMetrics/ios-branch-deep-linking/tags) (will need to update `plugin.xml` dependencies if new iOS files)
52+
> **[optional]** Update [Android](https://github.com/BranchMetrics/android-branch-deep-linking/releases) and [iOS](https://github.com/BranchMetrics/ios-branch-deep-linking/releases) SDKs
5653
5754
```sh
58-
./src/scripts/npm/updateIosSdk.sh 0.13.5;
59-
./src/scripts/npm/updateAndroidSdk.sh 2.5.9;
55+
./src/scripts/npm/updateNativeSdk.sh -a 2.5.9 -i 0.13.5
6056
```
6157

6258
### Test
6359

64-
> Modify `BRANCH_KEY` and `URI_SCHEME` and `config.xml` to values in [Branch Dashboard](https://dashboard.branch.io/settings/link)
65-
66-
```sh
67-
gulp prerelease; cd testbed; npm install -g cordova; cordova platform remove ios; cordova platform remove android; cordova platform remove browser; cordova platform add ios; cordova platform add android; cordova plugin remove branch-cordova-sdk; cordova plugin add ../ --variable BRANCH_KEY=key_live_icCccJIpd7GlYY5oOmoEtpafuDiuyXhT --variable URI_SCHEME=enefftest;
68-
69-
gulp prod;
70-
cd testbed;
71-
npm uninstall mkpath node-version-compare plist xml2js;
72-
rm -rf ../.installed;
73-
rm -rf ./plugins;
74-
rm -rf ./platforms;
75-
cordova platform add ios;
76-
cordova plugin add ../;
77-
cordova build ios --developmentTeam="PW4Q8885U7";
78-
open -a Xcode platforms/ios/Branch\ Testing.xcworkspace;
79-
80-
```
81-
8260
> Validate all features on both `iOS` and `Android` on `device` only (no `simulator` or `TestFlight`)
8361
62+
> ios
63+
8464
```sh
85-
cordova build ios --developmentTeam="PW4Q8885U7"; open -a Xcode platforms/ios/Branch\ Testing.xcworkspace;
65+
./testbed/init -idc
8666
```
67+
68+
> android
8769
8870
```sh
89-
cordova build android; cordova run android;
90-
chrome://inspect/#devices
71+
./testbed/init -adc
9172
```
9273

93-
> Test harnesses `TODO`
94-
9574
### Submit
9675

97-
> **Required** [Semantic Release](https://github.com/semantic-release/semantic-release) comments `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`
76+
> **Required** [Semantic Release](https://github.com/semantic-release/semantic-release) comments `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`. Versioning handled automatically based on commit messages.
9877
9978
> Submit code with a [pull request](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking)
100-
101-
```sh
102-
git checkout -b BRANCH_NAME;
103-
git add FILE_NAME;
104-
npm run commit;
105-
git push origin BRANCH_NAME;
106-
```
10779
10880
### Publish
10981

110-
> Update `CHANGELOG.md`
111-
> Update version within plugin.template.xml
112-
> Run `gulp prerelease`
113-
> Merge Pull Request - code to NPM will happen automatically
114-
115-
116-
## Hooks
117-
118-
Don't need to `rebuild.sh`, just re-run `cordova build ios`
82+
> Code review from a Branch member. Merge will automatically add SDK to NPM.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The MIT License (MIT)
1+
MIT License
22

33
Copyright (c) 2015 Branch Metrics, Inc.
44

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "branch-cordova-sdk",
33
"description": "Branch Metrics Cordova SDK",
44
"main": "www/branch.js",
5-
"version": "2.5.7",
5+
"version": "2.5.8",
66
"homepage": "https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking",
77
"repository": {
88
"type": "git",

plugin.template.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ SOFTWARE.
2424
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
2525
xmlns:android="http://schemas.android.com/apk/res/android"
2626
id="branch-cordova-sdk"
27-
version="2.5.7">
27+
version="2.5.8">
2828

2929
<!-- DO NOT EDIT THIS FILE. MAKE ALL CHANGES TO plugin.template.xml INSTEAD -->
3030

plugin.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ SOFTWARE.
2424
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
2525
xmlns:android="http://schemas.android.com/apk/res/android"
2626
id="branch-cordova-sdk"
27-
version="2.5.7">
27+
version="2.5.8">
2828

2929
<!-- DO NOT EDIT THIS FILE. MAKE ALL CHANGES TO plugin.template.xml INSTEAD -->
3030

src/ios/dependencies/Branch.framework/Branch

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/ios/dependencies/Branch.framework/Headers

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/ios/dependencies/Branch.framework/Info.plist

Lines changed: 0 additions & 42 deletions
This file was deleted.

src/ios/dependencies/Branch.framework/Modules/module.modulemap

Lines changed: 0 additions & 9 deletions
This file was deleted.
Binary file not shown.

0 commit comments

Comments
 (0)