🔧 Prepare @datadog/browser-rum-angular for beta release#4386
Conversation
Bundles Sizes Evolution
🚀 CPU PerformancePending... 🧠 Memory PerformancePending... |
|
✅ Tests 🎉 All green!❄️ No new flaky tests detected 🎯 Code Coverage (details) 🔗 Commit SHA: f16b798 | Docs | Datadog PR Page | Was this helpful? React with 👍/👎 or give us feedback! |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 10512fc26f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ```typescript | ||
| import { bootstrapApplication } from '@angular/platform-browser' | ||
| import { angularPlugin, provideDatadogErrorHandler } from '@datadog/browser-rum-angular' |
There was a problem hiding this comment.
Remove references to non-existent Angular error APIs
This README section documents provideDatadogErrorHandler/addAngularError imports from @datadog/browser-rum-angular, but the package entrypoint currently exports only angularPlugin, AngularPluginConfiguration, and provideDatadogRouter (packages/rum-angular/src/entries/main.ts). Users following this example will hit immediate TypeScript/module import errors, so the beta docs are advertising APIs that are not actually shippable in this commit.
Useful? React with 👍 / 👎.
| { | ||
| "name": "@datadog/browser-rum-angular", | ||
| "private": true, | ||
| "version": "6.31.0", |
There was a problem hiding this comment.
❓ question: Is this intended?
There was a problem hiding this comment.
Yes this is intended, after syncing we decided to have the integration package on the basic sdk version.
There was a problem hiding this comment.
So no preview or beta?
There was a problem hiding this comment.
no tag on npm yep 👍
It is mentionned in the readme that it is on the beta phase though
There was a problem hiding this comment.
❓ question: Is the intent to put the doc here for the beta release and then to move it to public doc?
Motivation
The
@datadog/browser-rum-angularpackage is currently marked asprivateand cannot be published to npm. This PR prepares it for a beta release by making it publishable.Changes
package.json: Replace"private": truewith"version": "6.31.0"so the package can be published to npm alongside other SDK packagesREADME.md: Add documentation that will be displayed on the npm package page. This serves as the primary documentation during the beta period, before the full public docs are available. It covers setup, error tracking (provideDatadogErrorHandler,addAngularError), and router integration.Related PRs