Skip to content

Conversation

@etanxing
Copy link
Contributor

@etanxing etanxing commented Jul 31, 2022

✌️

/cc @zendesk/vegemite

Description

We're going to enable ZAF SDK to be imported as a Node Module. PR #144 was previously raised, all points make sense.

Since we introduced Typescript we can't import lib/index.js directly. Instead, import dist/zaf_sdk.min.js which are the assets for npm publish.

If you want to install from github, npm install https://github.com/zendesk/zendesk_app_framework_sdk#"wxing/VEG-1404" --save.

import ZAFClient from 'zendesk_app_framework_sdk';
var client = ZAFClient.init();
...

Make sure to commit the latest dist by npm run build each time. Once we move to npm, it can be done via CI/CD.

Tasks

  • Include comments/inline docs where appropriate
  • Add unit tests
  • Update changelog here

References

DevQA Steps

NOTE: DevQA steps are to be actioned only once code has been reviewed and approved.

Risks

  • medium: it may impact to existing apps which are importing the SDK from our CDN via a <script> tag

Rollback Plan

  1. Quickly roll back to the prior release so that customers can refresh to resolve their issue.
  2. Revert this PR to restore the master branch to a deployable green state.
  3. Notify the author.

@etanxing etanxing marked this pull request as ready for review August 1, 2022 00:56
@etanxing etanxing requested a review from a team August 1, 2022 00:57
@etanxing etanxing merged commit 703021e into master Aug 3, 2022
@zendesk-deploy
Copy link

This PR was deployed to Static Assets Build. Reference: v2.0.36

@zendesk-deploy
Copy link

This PR was deployed to Static Assets Switch Staging. Reference: v2.0.36

@zendesk-deploy
Copy link

This PR was deployed to Static Assets Switch Major (v2). Reference: v2.0.36

@bkw
Copy link

bkw commented Dec 5, 2024

This no longer works for people who have no snyk token.

@bkw bkw mentioned this pull request Dec 5, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants