BranchMetrics / web-branch-deep-linking-attribution

The Branch Web SDK for deep linking and attribution. Once initialized, the Branch Web SDK allows you to create and share links with a banner (web only), over SMS, or your own methods by generating deep links. It also offers event tracking, access to referrals, and management of credits.
https://help.branch.io/developers-hub/docs/web-sdk-overview
MIT License
287 stars 101 forks source link

[SDK-2072] Create GHA to sync release notes with ReadMe Version History #931

Closed nsingh-branch closed 10 months ago

nsingh-branch commented 10 months ago

Description

Created a new Github Action that runs whenever a new Github Release is made. It uses the release tag and description to create a new section in the public readme doc's version history page. It also uses this data to send a Slack message in the SDK channel announcing the new release.

Fixes # (issue)

SDK-2072 -- Help Docs automate Readme changelogs

Type of change

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

Using Act and actual releases in a test repo.

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:

Mentions:

List the person or team responsible for reviewing proposed changes.

cc @BranchMetrics/saas-sdk-devs for visibility.

github-actions[bot] commented 10 months ago

Test Results

112 tests   105 :heavy_check_mark:  55s :stopwatch:     1 suites      7 :zzz:     1 files        0 :x:

Results for commit 334090f9.

:recycle: This comment has been updated with latest results.

codecov[bot] commented 10 months ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (master@802e68a). Click here to learn what that means. The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #931   +/-   ##
=========================================
  Coverage          ?   24.59%           
=========================================
  Files             ?       15           
  Lines             ?     2322           
  Branches          ?        0           
=========================================
  Hits              ?      571           
  Misses            ?     1751           
  Partials          ?        0