carbon-addons-iot-react icon indicating copy to clipboard operation
carbon-addons-iot-react copied to clipboard

chore: onboard carbon-addons-iot-react to IBM Telemetry 🚀

Open mattrosno opened this issue 10 months ago • 2 comments

Summary

Adds the config file and dependency necessary to start tracking telemetry data via IBM Telemetry for the packages:

  • carbon-addons-iot-react

The jsx config was generated by running the JS config generator in /packages/react with the command:

npx -y @ibm/telemetry-js-config-generator --id 57ff13d6-cb2e-4a9c-8489-a1c7ceea1b16 --endpoint https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics --files ./src/**/*.(tsx|js|jsx)

Change List (commits, features, bugs, etc)

  • Adds @ibm/telemetry-js dependency
  • Adds telemetry.yml config file
  • Adds readme telemetry notice
  • Adds telemetry.yml as an exported file if the package specifies files
  • Removes @carbon/telemetry
  • Updates postinstall script to use the new telemetry command

Acceptance Test (how to verify the PR)

Please look through package.json config files and ensure all necessary modifications have been made so that the "telemetry.yml" config file is included in the release version of each package.

PLEASE NOTE: In order for IBM Telemetry to start collecting data for this project, a new build must be published including these changes.

Regression Test (how to make sure this PR doesn't break old functionality)

  • N/A

Things to look for during review

  • [ ] Make sure all references to iot or bx class prefix is using the prefix variable
  • [ ] (React) All major areas have a data-testid attribute. New test ids should have test written to ensure they are not changed or removed.
  • [ ] UI should be checked in RTL mode to ensure the proper handling of layout and text.
  • [ ] All strings should be translatable.
  • [ ] The code should pass a11y scans (The storybook a11y knob should show no violations). New components should have a11y test written.
  • [ ] Unit test should be written and should have a coverage of 90% or higher in all areas.
  • [ ] All components should be passing visual regression test. For new styles or components either a visual regression test should be written for all permutations or the base image updated.
  • [ ] Changes or new components should either write new or update existing documentation.
  • [ ] PR should link and close out an existing issue

mattrosno avatar Mar 27 '24 18:03 mattrosno

Deploy Preview for carbon-addons-iot-react ready!

Name Link
Latest commit d2291c32d151d56a899f327f14a98870bfdab6d7
Latest deploy log https://app.netlify.com/sites/carbon-addons-iot-react/deploys/66045f02d2e1cd0008b2bb50
Deploy Preview https://deploy-preview-3854--carbon-addons-iot-react.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Mar 27 '24 18:03 netlify[bot]

Deploy Preview for carbon-addons-iot-react ready!

Name Link
Latest commit 123f0223cc7c4f1b3fa7704c3e48336b09f9e18a
Latest deploy log https://app.netlify.com/sites/carbon-addons-iot-react/deploys/662a87dd2b69c2000868696b
Deploy Preview https://deploy-preview-3854--carbon-addons-iot-react.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Mar 27 '24 18:03 netlify[bot]

Hi @cgirani - I see you've reviewed a few of the recent PRs in this repo. Are you able to review this PR? Please let me know if you have any questions.

mattrosno avatar Apr 09 '24 20:04 mattrosno