1
1
# Developing the SDK Locally
2
+
2
3
* Questions? [ Contact us] ( https://support.branch.io/support/tickets/new ) *
3
4
4
5
1 . [ Dependencies] ( #dependencies )
@@ -25,13 +26,13 @@ export PATH="/usr/local/bin:$PATH";
25
26
26
27
``` sh
27
28
brew install node;
28
- ```
29
+ ```
29
30
30
31
> Gulp
31
32
32
33
``` sh
33
34
npm install -g gulp-cli;
34
- ```
35
+ ```
35
36
36
37
### SDK
37
38
@@ -46,12 +47,8 @@ npm install --save-dev;
46
47
47
48
### Develop
48
49
49
- > Build
50
+ > Changes to ` /src ` don't need a ` init.sh ` rebuild, just a ` cordova run ios `
50
51
51
- ``` sh
52
- gulp prerelease;
53
- ```
54
-
55
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
56
53
57
54
``` sh
@@ -60,58 +57,26 @@ gulp prerelease;
60
57
61
58
### Test
62
59
63
- > Modify ` BRANCH_KEY ` and ` URI_SCHEME ` and ` config.xml ` to values in [ Branch Dashboard] ( https://dashboard.branch.io/settings/link )
64
-
65
- ``` sh
66
- 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;
67
-
68
- gulp prod;
69
- cd testbed;
70
- npm uninstall mkpath node-version-compare plist xml2js;
71
- rm -rf ../.installed;
72
- rm -rf ./plugins;
73
- rm -rf ./platforms;
74
- cordova platform add ios;
75
- cordova plugin add ../;
76
- cordova build ios --developmentTeam=" PW4Q8885U7" ;
77
- open -a Xcode platforms/ios/Branch\ Testing.xcworkspace;
78
-
79
- ```
80
-
81
60
> Validate all features on both ` iOS ` and ` Android ` on ` device ` only (no ` simulator ` or ` TestFlight ` )
82
61
62
+ > ios
63
+
83
64
``` sh
84
- cordova build ios --developmentTeam= " PW4Q8885U7 " ; open -a Xcode platforms/ios/Branch \ Testing.xcworkspace ;
65
+ ./testbed/init -idc
85
66
```
67
+
68
+ > android
86
69
87
70
``` sh
88
- cordova build android; cordova run android;
89
- chrome://inspect/# devices
71
+ ./testbed/init -adc
90
72
```
91
73
92
- > Test harnesses ` TODO `
93
-
94
74
### Submit
95
75
96
- > ** 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.
97
77
98
78
> Submit code with a [ pull request] ( https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking )
99
-
100
- ``` sh
101
- git checkout -b BRANCH_NAME;
102
- git add FILE_NAME;
103
- npm run commit;
104
- git push origin BRANCH_NAME;
105
- ```
106
79
107
80
### Publish
108
81
109
- > Update ` CHANGELOG.md `
110
- > Update version within plugin.template.xml
111
- > Run ` gulp prerelease `
112
- > Merge Pull Request - code to NPM will happen automatically
113
-
114
-
115
- ## Hooks
116
-
117
- 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.
0 commit comments