Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pkg(secrets): Add bundler instructions to EXTENDERS.md; fix README link; resolve pkg root for prebuilds #1783

Merged
merged 15 commits into from
Aug 15, 2023

Conversation

traeok
Copy link
Member

@traeok traeok commented Aug 11, 2023

What It Does

This PR adds the following:

  • feat: The Secrets SDK package now resolves the prebuilds/ folder
  • fix: link in README.md worked locally and in GitHub, but not from NPM's website
  • doc: Enhanced EXTENDERS.md to include steps on how to bundle the Secrets SDK alongside a webpacked extension/package

How to Test

To test the enhancement, run the prepublishOnly script after building the Secrets SDK, and then run the test stage:

  • npm install
  • npm run prepublishOnly && npm run build && npm run test

The Secrets SDK will use the prebuilds folder in its package root to resolve & load the Node-native binary.

Review Checklist
I certify that I have:

Additional Comments

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@codecov
Copy link

codecov bot commented Aug 11, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (6179500) 92.82% compared to head (054f639) 92.82%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1783   +/-   ##
=======================================
  Coverage   92.82%   92.82%           
=======================================
  Files         423      423           
  Lines        7191     7191           
  Branches     1319     1319           
=======================================
  Hits         6675     6675           
  Misses        515      515           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@traeok traeok changed the title pkg(secrets): Add bundler instructions to EXTENDERS.md; fix README link; resolve pkg root for prebuilds pkg(secrets): Add bundler instructions to EXTENDERS.md; fix README link; resolve pkg root for prebuilds Aug 11, 2023
@traeok traeok marked this pull request as draft August 11, 2023 17:49
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@traeok traeok marked this pull request as ready for review August 11, 2023 18:37
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@traeok traeok force-pushed the doc/secrets/webpack-and-import branch from 98c1493 to b94a9ed Compare August 14, 2023 14:47
@traeok traeok requested a review from t1m0thyj August 14, 2023 14:48
…age.json

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@traeok traeok force-pushed the doc/secrets/webpack-and-import branch from a4e31b5 to b858ee0 Compare August 14, 2023 15:22
@traeok traeok force-pushed the doc/secrets/webpack-and-import branch from 4be4b5d to 6c5edd6 Compare August 14, 2023 15:38
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@traeok traeok force-pushed the doc/secrets/webpack-and-import branch from 6c5edd6 to 652d705 Compare August 14, 2023 15:38
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@traeok traeok force-pushed the doc/secrets/webpack-and-import branch from 495abe5 to 75e812a Compare August 14, 2023 18:14
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@traeok traeok force-pushed the doc/secrets/webpack-and-import branch from be633c5 to 8ba3790 Compare August 14, 2023 19:07
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@traeok traeok force-pushed the doc/secrets/webpack-and-import branch from 23e6621 to 0defd96 Compare August 14, 2023 19:49
Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@traeok traeok force-pushed the doc/secrets/webpack-and-import branch from 0defd96 to a350487 Compare August 14, 2023 19:49
@traeok traeok requested a review from t1m0thyj August 14, 2023 19:50
Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @traeok!

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@sonarcloud
Copy link

sonarcloud bot commented Aug 14, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@traeok traeok merged commit dd48939 into master Aug 15, 2023
22 checks passed
@traeok traeok deleted the doc/secrets/webpack-and-import branch August 15, 2023 12:38
@traeok traeok added the release-current Indicates that there is no new functionality being delivered label Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-current Indicates that there is no new functionality being delivered
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants