Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ All notable changes to the Branch Web SDK will be documented here.
The Branch Web SDK adheres to [Semantic Versioning](http://semver.org/).

## [VERSION] - unreleased
## [2.85.1] - 2024-11-04
- Updates qr image download to avoid errors
## [2.85.0] - 2024-04-10
- SDK-2236: adds script to launch a local runner
- updates jsdom, mocha
## [2.84.0] - 2024-02-28
- fix(SDK-2255): removes defaults for parameter values of setDMAParamsForEEA method
## [2.82.0] - 2024-02-15
Expand Down
17 changes: 5 additions & 12 deletions RELEASE_DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

**Last Updated**: Sep. 24th, 2015

The entire process for releasing new versions of the Branch SDK, and geenrating accompanying doumentation, is enitrley automated.
The entire process for releasing new versions of the Branch SDK, and generating accompanying documentation, is entirely automated.

### Features of Build and Release Automation
+ **Makefile**
+ Building and minification with Google Closure Compiler
+ gzip of minified JavaScript
+ Embeding of Branch snipet on the Web testbed
+ Embedding of Branch snipet on the integration Mocha.js test page
+ Embedding of Branch snippet on the Web testbed
+ Embedding of Branch snippet on the integration Mocha.js test page
+ Documentation generation from JSDoc style inline comments from `src/3_branch.js`
+ Concatenation of a summary README that includes an introduction, most recent Web snipet, and overview of Web Smart Banner
+ Concatenation of a summary README that includes an introduction, most recent Web snippet, and overview of Web Smart Banner
+ Concatenation of full documentation for Web of an introduction, an automatically generated table of contents, and JSDoc generated function descriptions and spec.

+ **Release.sh**
Expand Down Expand Up @@ -58,13 +58,6 @@ The markdown files concatenated together to make the Full Web SDK documentation,
## Releasing the Web SDK
The entire release process has been encapsulated into a single shell script: `release.sh`. The release script has a few dependencies you'll need to make sure you have installed: [AWS CLI](http://aws.amazon.com/cli/), [make](http://www.gnu.org/software/make/), and you'll need environment variables to upload the SDK and Web testbed to S3. For convenience, I've placed mine in a simple shell script that I have added to `.gitignore`:
`aws_access_keys.sh`
```sh
#!/bin/bash

export AWS_ACCESS_KEY_ID='ID_GOES_HERE'
export AWS_SECRET_ACCESS_KEY='ACCESS_KEY_GOES_HERE'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not how we do aws access keys, so i removed it

```

**VERY IMPORTANT**: Do not, in anyway, commit the S3 credentials to this repository. If you store them in a shell script, name it `aws_access_keys.sh`, or add it's name to `.gitignore` so that it is not committed.

The release schell script is a simple wizard. Once your S3 environment variables are set, and you have been added to the Branch npmjs.org account, simple run :`./release.sh` and follow the steps.
The release shell script is a simple wizard. Once your S3 environment variables are set, and you have been added to the Branch npmjs.org account, simple run :`./release.sh` and follow the steps.
204 changes: 100 additions & 104 deletions dist/build.js

Large diffs are not rendered by default.

164 changes: 82 additions & 82 deletions dist/build.min.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions example.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta content="http://branch.io/img/logo_icon_black.png" property="og:image" />
<meta content="Branch Metrics Web SDK Example App" property="og:title" />
<meta content="A basic example to demonstrate some of the ways that the Web SDK can be used" property="og:description" />
<meta content='key_live_feebgAAhbH9Tv85H5wLQhpdaefiZv5Dv' name='branch_key'/>
<meta content='key_place_holder' name='branch_key'/>
<title>Branch Metrics Web SDK Example App</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
<style type="text/css">
Expand Down Expand Up @@ -82,7 +82,7 @@ <h4>QR Code</h4>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
<script type="text/javascript">
(function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="https://cdn.branch.io/branch-latest.min.js";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setDMAParamsForEEA setAPIUrl getAPIUrl".split(" "), 0);
(function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="SCRIPT_URL_HERE";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setDMAParamsForEEA setAPIUrl getAPIUrl".split(" "), 0);

branch.setAPIResponseCallback(function(url, method, requestBody, error, status, responseBody) {
console.log('Request: ' + method + ' ' + url + ' body=' + JSON.stringify(requestBody));
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "branch-sdk",
"version": "2.84.0",
"version": "2.85.1",
"description": "Branch Metrics Deep Linking/Smart Banner Web SDK",
"main": "dist/build.min.js",
"files": [
Expand Down
2 changes: 1 addition & 1 deletion startDev.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ async function startDev() {
console.error(`Error executing makefile: ${error.message}`);
return;
}
console.log('Dev build successfull.');
console.log('Dev build successful.');
console.log('Starting server...');
const app = new Koa();
app.use(serve('dev'));
Expand Down
2 changes: 1 addition & 1 deletion test/integration-test.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

<script type="text/javascript">

(function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="../dist/build.js";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setDMAParamsForEEA setAPIUrl getAPIUrl".split(" "), 0);
(function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="SCRIPT_URL_HERE";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setDMAParamsForEEA setAPIUrl getAPIUrl".split(" "), 0);
</script>

<script type="text/javascript" src="7_integration.js"></script>
Expand Down
Loading