[other] ENGMT-1857: add gha for release #1083

bredmond5 · 2024-11-06T18:26:49Z

Pull Request Template

Description

Uses the github release version as the source of truth, this is what we do in our other repositories. Updates the package.json and various configs with the proper version.

This means that the new versions will not be checked into the repo, but they will be deployed properly. I am not sure if that is problematic

Removes checking in the build.js and build.min.js in favor of always having it built at runtime then deployed

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.

bredmond5 · 2024-11-06T18:27:17Z

deployment/deploy-qa.sh

  aws s3 cp example.html s3://branch-cdn/example-staging.html

-  ./deployment/build-example-html.sh "key_live_hcnegAumkH7Kv18M8AOHhfgiohpXq5tB" "https://api2.branch.io" "https://cdn.branch.io/branch-latest.min.js"
-  aws s3 cp example.html s3://branch-builds/web-sdk/example.html


was looking at this more, we did this before my previous pr so i kept it in that pr. But, i dont understand the point of this so i removed it

how is the example page going to be uploaded in this new flow?

looks like it happens in a later file

yeah this was deploying to prod, and also under this web-sdk prefix for some reason

bredmond5 · 2024-11-06T18:28:44Z

release.sh

 check_git_branch

-# update to the latest
-git pull origin master


weird, removed

bredmond5 · 2024-11-06T18:28:54Z

release.sh

-if [[ $REPLY =~ ^[Yy]$ ]]
-then
-  vi CHANGELOG.md
-  git commit -am "Updated CHANGELOG.md"


we said we want to have the changelog be manual, so removed

isn't this manual?

i mean manual as in going into the file and making the edits yourself, then committing

bredmond5 · 2024-11-06T18:29:02Z

release.sh

-
-echo "Building files"
-
-read -p "Update 0_config.js? " -n 1 -r


i made this happen by default

bredmond5 · 2024-11-06T18:29:25Z

release.sh

-  sed -i -e "s/version = '.*';$/version = '$VERSION_NO_V';/" test/web-config.js
-fi
-
-read -p "Update package.json? " -n 1 -r


happens earlier in the gha, before npm ci. I think we need to do that because we need the package.json updated before we run npm ci

bredmond5 · 2024-11-06T18:29:48Z

release.sh

-  sed -i -e "s/## \[VERSION\] - unreleased/## [$VERSION] - $DATE/" CHANGELOG.md
-fi
-
-read -p "Update bower.json? " -n 1 -r


this file seems not used anymore. I left it for now in case removing it blows some things up, but we no longer have an option to write to it

bredmond5 · 2024-11-06T18:30:08Z

release.sh

-fi
-
-echo "Done script."
-read -p "Have you updated the javascript version in https://github.com/BranchMetrics/documentation/edit/master/ingredients/web_sdk/_initialization.md ?" -n 1 -r


this is a dead link

bredmond5 · 2024-11-06T18:30:21Z

release.sh

-fi
-
-echo "Last step, run:"
-echo "    git push; git push origin $VERSION"


we're no longer committing the version changes

bredmond5 · 2024-11-06T18:30:43Z

src/0_config.js

 config.link_service_endpoint = 'https://bnc.lt';
 config.api_endpoint = DEFAULT_API_ENDPOINT;
-config.version = '2.84.0';
+config.version = '2.85.1';


i checked this in, but technically it is not necessary anymore since the release updates the files before publishing

github-actions · 2024-11-06T18:31:53Z

Test Results

1 files ±0 1 suites ±0 52s ⏱️ -13s
159 tests ±0 152 ✅ ±0 7 💤 ±0 0 ❌ ±0
162 runs ±0 155 ✅ ±0 7 💤 ±0 0 ❌ ±0

Results for commit c8a3f69. ± Comparison against base commit 9fe08bb.

♻️ This comment has been updated with latest results.

bredmond5 · 2024-11-06T18:33:06Z

release.sh

-fi
+echo -en "Invalidating cloudfront distribution...\n"
+aws configure set preview.cloudfront true
+aws cloudfront create-invalidation --distribution-id E10P37NG0GMER --paths /branch-latest.min.js


i added cache invalidation

ahmednawar · 2024-11-06T18:37:47Z

dist/build.js

 config.link_service_endpoint = "https://bnc.lt";
 config.api_endpoint = DEFAULT_API_ENDPOINT;
-config.version = "2.84.0";
+config.version = "2.85.1";


is this supposed to be updated as part of this PR?

i added a pr comment about this above

ahmednawar · 2024-11-06T18:39:31Z

package.json

 {
  "name": "branch-sdk",
-  "version": "2.85.1",
+  "version": "0.0.0",


what's the point of zeroing it out?

since we are no longer going to be checking in updates to this file, it makes it clear that the version numbers that we publish come from somewhere else

Uses the github release as the source of truth. Updates the package.json and various configs with the proper version. This means that the new versions will not be checked into the repo, but they will be deployed properly. I am not sure if that is problematic

mack-branch · 2024-11-07T00:55:17Z

.github/workflows/deploy-release.yml

+          ./deployment/release.sh ${{ steps.next-version.outputs.result }}
+
+      # We deploy to stage to send the updated release numbers. The code should not be any different
+      - name: Release to stage


wouldnt we want to do this first? before prod?

i mean like as a separate step

kind of like how we deploy applications to staging, then verify, then manually release to prod

could we stage the gha release and new version, and then have a manual action to put this on the prod cdn? does that make sense for something like this?

i didnt want to increment the version every time in staging, just increment when we actually deploy. However, that would be another solutoin i suppose

my worry would be something like: adds major commit -> updates major version. Finds bug, tags commit major again because we had to change some other part of the api. Now, when we deploy to prod we have incremented 2 versions when we prob should have just done 1

For manual pre-production "publications" we use alpha and beta suffixes. Example being https://www.npmjs.com/package/react-native-branch/v/6.4.0-alpha.0 Incrementing only the last part, without messing with the eventual version (as a suggestion)

ah gotcha, sorry, was unaware we were already deploying to staging separately. what youve got looks good, unless maybe we can use the beta/alpha tags like gabe is indicating?

that is an interesting idea, but i think i came up with a better solution

I am just always going to calculate the next version in staging and deploy that. I.e:

current: 2.84, next 2.85

every staging deploy, we check, get 2.84, and deploy 2.85. The github release wont change tho!

on prod, we deploy 2.85, and write 2.85 to releaeses.

Then, next stage deploy we will deploy 2.86 over and over... and on and on

mack-branch

one question, otherwise lgtm.

.github/workflows/build-push.yml

bredmond5 commented Nov 6, 2024

View reviewed changes

release.sh

check_git_branch

# update to the latest

git pull origin master

Copy link

Contributor Author

bredmond5 Nov 6, 2024

Choose a reason for hiding this comment

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

weird, removed

bredmond5 commented Nov 6, 2024

View reviewed changes

release.sh

echo "Building files"

read -p "Update 0_config.js? " -n 1 -r

Copy link

Contributor Author

bredmond5 Nov 6, 2024

Choose a reason for hiding this comment

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

i made this happen by default

bredmond5 commented Nov 6, 2024

View reviewed changes

bredmond5 force-pushed the deployment branch from 635bd62 to d914845 Compare November 6, 2024 18:31

bredmond5 changed the title ~~Deployment~~ [other] add gha for release Nov 6, 2024

bredmond5 changed the title ~~[other] add gha for release~~ [other] ENGMT-1857: add gha for release Nov 6, 2024

bredmond5 requested review from ahmednawar, gdeluna-branch and mack-branch November 6, 2024 18:32

bredmond5 commented Nov 6, 2024

View reviewed changes

bredmond5 force-pushed the deployment branch from d914845 to 39fbda1 Compare November 6, 2024 18:34

ahmednawar reviewed Nov 6, 2024

View reviewed changes

bredmond5 force-pushed the deployment branch 2 times, most recently from 3453cb9 to f770ade Compare November 6, 2024 19:36

bredmond5 added 3 commits November 6, 2024 16:42

[other] add gha deployment

0a2c7ac

[other] add gha for release

1a9076e

Uses the github release as the source of truth. Updates the package.json and various configs with the proper version. This means that the new versions will not be checked into the repo, but they will be deployed properly. I am not sure if that is problematic

update to make staging and prod sync

06be1f3

bredmond5 force-pushed the deployment branch from f770ade to 06be1f3 Compare November 7, 2024 00:43

mack-branch reviewed Nov 7, 2024

View reviewed changes

mack-branch approved these changes Nov 7, 2024

View reviewed changes

pr comments

38da4dd

bredmond5 force-pushed the deployment branch from 4ecf8c1 to 38da4dd Compare November 7, 2024 01:24

gdeluna-branch approved these changes Nov 7, 2024

View reviewed changes

cleanup

c8a3f69

bredmond5 requested review from gdeluna-branch and mack-branch November 7, 2024 18:02

gdeluna-branch reviewed Nov 7, 2024

View reviewed changes

.github/workflows/build-push.yml Show resolved Hide resolved

bredmond5 merged commit f930b9b into master Nov 7, 2024
5 checks passed

[other] ENGMT-1857: add gha for release #1083

[other] ENGMT-1857: add gha for release #1083

Uh oh!

Conversation

bredmond5 commented Nov 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Template

Description

Type of change

How Has This Been Tested?

JS Budget Check

Checklist:

Mentions:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bredmond5 Nov 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bredmond5 Nov 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gdeluna-branch Nov 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bredmond5 commented Nov 6, 2024 •

edited

Loading

github-actions bot commented Nov 6, 2024 •

edited

Loading

bredmond5 Nov 6, 2024 •

edited

Loading

bredmond5 Nov 7, 2024 •

edited

Loading

gdeluna-branch Nov 7, 2024 •

edited

Loading