chore: Add browser-telemetry to release please. #745
Conversation
|
|
||
| release-browser-telemetry: | ||
| runs-on: ubuntu-latest | ||
| needs: ['release-please', 'release-browser'] |
There was a problem hiding this comment.
Currently we are using the browser package for some type imports.
|
@launchdarkly/js-sdk-common size report |
|
@launchdarkly/js-client-sdk-common size report |
|
@launchdarkly/js-client-sdk size report |
| permissions: | ||
| id-token: write | ||
| contents: write | ||
| if: ${{ always() && !failure() && !cancelled() && needs.release-please.outputs.package-browser-telemetry-released == 'true' }} |
There was a problem hiding this comment.
This incantation allows us to depend on 'release-browser' without requiring that the browser package is being released.
Basically if release-browser is going to run, and it fails, cancel this step.
If it is ran, and it is a success, then run this step.
If it is not ran, but we need to release because we have out own changes, then run this step.
There was a problem hiding this comment.
Consider adding this comment to the file for posterity.
There was a problem hiding this comment.
This pattern is used extensively for this project. We probably need a centralized explanation of how to do this.
| @@ -68,7 +68,7 @@ export interface Breadcrumb { | |||
| /** | |||
| * Utility type which allows for easy extension of base breadcrumb type. | |||
| */ | |||
| type ImplementsCrumb<U extends Breadcrumb> = U; | |||
| export type ImplementsCrumb<U extends Breadcrumb> = U; | |||
There was a problem hiding this comment.
This needs to be exported for documentation generation purposes, but it isn't expected that an application developer would use it.
| * {@link breadcrumbs.http.customUrlFilter}. | ||
| * If any filter throws an exception, then the error data will be discarded. | ||
| * | ||
| * For filtering breadcrumbs or URLs in error data, refer to the `breadcrumbs.filters` option in {@link breadcrumbs} and |
There was a problem hiding this comment.
Just some changes to get documentation links working.
| @@ -65,6 +65,9 @@ | |||
| "jsonpath": "$.dependencies['@launchdarkly/server-sdk-ai']" | |||
| } | |||
| ] | |||
| }, | |||
| "packages/telemetry/browser-telemetry": { | |||
| "bump-minor-pre-major": true | |||
There was a problem hiding this comment.
Prior to 1.0 we want to increment the minor.
0.1.0 -> 0.2.0 etc.
When we do the 1.0 release this will be removed.
| permissions: | ||
| id-token: write | ||
| contents: write | ||
| if: ${{ always() && !failure() && !cancelled() && needs.release-please.outputs.package-browser-telemetry-released == 'true' }} |
There was a problem hiding this comment.
Consider adding this comment to the file for posterity.
Add release-please support for browser-telemetry and address a number of minor issues.
BEGIN_COMMIT_OVERRIDE
chore: Add browser-telemetry to release please.
fix: Export BrowserTelemetry, BrowserTelemetryInspector, and ImplementsCrumb.
chore: Update documentation comment links that were invalid.
feat: Rename initializeTelemetryInstance to initTelemetryInstance for consistency with initTelemetry.
END_COMMIT_OVERRIDE