-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
chore: update react package telemetry config #17837
chore: update react package telemetry config #17837
Conversation
✅ Deploy Preview for v11-carbon-web-components ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for carbon-elements ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for v11-carbon-react ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this! Instead of running it automatically I added a commit that updates ci to check if the file needs updated. It's basically the same idea as the format
check where it fails if changes are needed - you have to make the change locally and push up the changes to get the status check to pass.
Let me know what you think - I can revert that commit if there's some gaps I missed.
@tay1orjones I like it. I didn't make any changes to the |
@tay1orjones I guess this could be used in the 3 other React-based packages where each script command uses its own project ID: https://github.com/search?q=repo%3Acarbon-design-system%2Fcarbon%20allowedAttributeNames&type=code But if these other packages rarely add/remove component props, it might not be worth the effort. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17837 +/- ##
=======================================
Coverage 80.19% 80.19%
=======================================
Files 406 406
Lines 14040 14040
Branches 4347 4395 +48
=======================================
Hits 11260 11260
+ Misses 2614 2613 -1
- Partials 166 167 +1 ☔ View full report in Codecov by Sentry. |
@mattrosno great point - I'll push an update and fix the new check too, it needs a |
…carbon into update-react-telemetry-config
I couldn't figure out why the CI check was reporting a difference in the config - whenever I would run it locally it was fine. I tried a bunch of stuff but gave up. Left in the script though so it's easier to update this! |
106e804
A while back, the
FeatureFlags
component was updated from a single prop of type object, to one prop per feature, so this data can be captured by IBM Telemetry. These new props need added to thetelemetry.yml
'sallowedAttributeNames
.I ran this command in the
/packages/react
directory:The Telemetry team maintains
@ibm/telemetry-js-config-generator
, although it's up to you how you use it. E.g. manually if you add a net-new prop or prop value, or pro mode would be automatically somehow.Changelog
New
Changed
telemetry.yml
re-generatedRemoved
Testing / Reviewing
I can't figure out why the new YML files doesn't have quotes anymore, making the PR more difficult to diff. This view seems best for this PR:
You should see new props included if no components used them the last time this file was generated. For example,
enableV12Overflowmenu
.