Skip to content

Commit b474851

Browse files
authored
[other] check in new release files (#1078)
# Pull Request Template ## Description previous pr #1075 I didnt understand that i was supposed to do this before, updated now Fixes # (issue) ## Type of change Please delete options that are not relevant. - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update ## How Has This Been Tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - [ ] Unit test - [ ] Integration test ## JS Budget Check Please mention the size in kb before abd after this PR | Files | Before | After | | ----------- | ----------- | ----------- | | dist/build.js. | | | | dist/build.min.js| | | ## Checklist: - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules - [ ] I have checked my code and corrected any misspellings ## Mentions: List the person or team responsible for reviewing proposed changes. cc @BranchMetrics/saas-sdk-devs for visibility.
1 parent 41840c9 commit b474851

File tree

8 files changed

+197
-203
lines changed

8 files changed

+197
-203
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ All notable changes to the Branch Web SDK will be documented here.
33
The Branch Web SDK adheres to [Semantic Versioning](http://semver.org/).
44

55
## [VERSION] - unreleased
6+
## [2.85.1] - 2024-11-04
7+
- Updates qr image download to avoid errors
8+
## [2.85.0] - 2024-04-10
9+
- SDK-2236: adds script to launch a local runner
10+
- updates jsdom, mocha
611
## [2.84.0] - 2024-02-28
712
- fix(SDK-2255): removes defaults for parameter values of setDMAParamsForEEA method
813
## [2.82.0] - 2024-02-15

RELEASE_DOCUMENTATION.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

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

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

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

1717
+ **Release.sh**
@@ -58,13 +58,6 @@ The markdown files concatenated together to make the Full Web SDK documentation,
5858
## Releasing the Web SDK
5959
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`:
6060
`aws_access_keys.sh`
61-
```sh
62-
#!/bin/bash
6361

64-
export AWS_ACCESS_KEY_ID='ID_GOES_HERE'
65-
export AWS_SECRET_ACCESS_KEY='ACCESS_KEY_GOES_HERE'
66-
```
6762

68-
**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.
69-
70-
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.
63+
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.

dist/build.js

Lines changed: 100 additions & 104 deletions
Large diffs are not rendered by default.

dist/build.min.js

Lines changed: 82 additions & 82 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

example.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta content="http://branch.io/img/logo_icon_black.png" property="og:image" />
66
<meta content="Branch Metrics Web SDK Example App" property="og:title" />
77
<meta content="A basic example to demonstrate some of the ways that the Web SDK can be used" property="og:description" />
8-
<meta content='key_live_feebgAAhbH9Tv85H5wLQhpdaefiZv5Dv' name='branch_key'/>
8+
<meta content='key_place_holder' name='branch_key'/>
99
<title>Branch Metrics Web SDK Example App</title>
1010
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
1111
<style type="text/css">
@@ -82,7 +82,7 @@ <h4>QR Code</h4>
8282
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
8383
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
8484
<script type="text/javascript">
85-
(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);
85+
(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);
8686

8787
branch.setAPIResponseCallback(function(url, method, requestBody, error, status, responseBody) {
8888
console.log('Request: ' + method + ' ' + url + ' body=' + JSON.stringify(requestBody));

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "branch-sdk",
3-
"version": "2.84.0",
3+
"version": "2.85.1",
44
"description": "Branch Metrics Deep Linking/Smart Banner Web SDK",
55
"main": "dist/build.min.js",
66
"files": [

startDev.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ async function startDev() {
3131
console.error(`Error executing makefile: ${error.message}`);
3232
return;
3333
}
34-
console.log('Dev build successfull.');
34+
console.log('Dev build successful.');
3535
console.log('Starting server...');
3636
const app = new Koa();
3737
app.use(serve('dev'));

test/integration-test.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
<script type="text/javascript">
2525

26-
(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);
26+
(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);
2727
</script>
2828

2929
<script type="text/javascript" src="7_integration.js"></script>

0 commit comments

Comments
 (0)