Skip to content

Commit 3eeecf6

Browse files
authored
chore: Add combined browser package. (#871)
Scaffolds the combined browser package. This is a package with pre-configured observability.
1 parent e8f9b9a commit 3eeecf6

25 files changed

+515
-4
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: '@launchdarkly/browser Bug Report'
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'package: sdk/combined-browser, bug'
6+
assignees: ''
7+
---
8+
9+
**Is this a support request?**
10+
This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the code in this library. If you're not sure whether the problem you are having is specifically related to this library, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing [email protected].
11+
12+
Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above.
13+
14+
**Describe the bug**
15+
A clear and concise description of what the bug is.
16+
17+
**To reproduce**
18+
Steps to reproduce the behavior.
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Logs**
24+
If applicable, add any log output related to your problem.
25+
26+
**SDK version**
27+
The version of this SDK that you are using.
28+
29+
**Language version, developer tools**
30+
For instance, Go 1.11 or Ruby 2.5.3. If you are using a language that requires a separate compiler, such as C, please include the name and version of the compiler too.
31+
32+
**OS/platform**
33+
For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the browser type and version.
34+
35+
**Additional context**
36+
Add any other context about the problem here.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: '@launchdarkly/browser Feature Request'
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'package: sdk/combined-browser, feature'
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context about the feature request here.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: sdk/combined-browser
2+
3+
on:
4+
push:
5+
branches: [main, 'feat/**']
6+
paths-ignore:
7+
- '**.md' #Do not need to run CI for markdown changes.
8+
pull_request:
9+
branches: [main, 'feat/**']
10+
paths-ignore:
11+
- '**.md'
12+
13+
jobs:
14+
build-test-browser:
15+
permissions:
16+
pull-requests: write
17+
runs-on: ubuntu-latest
18+
19+
strategy:
20+
matrix:
21+
# Node versions to run on.
22+
version: [18, 21]
23+
24+
steps:
25+
- uses: actions/checkout@v4
26+
- uses: actions/setup-node@v4
27+
with:
28+
node-version: ${{ matrix.version }}
29+
registry-url: 'https://registry.npmjs.org'
30+
- id: shared
31+
name: Shared CI Steps
32+
uses: ./actions/ci
33+
with:
34+
workspace_name: '@launchdarkly/browser'
35+
workspace_path: packages/sdk/combined-browser
36+
- name: Check package size
37+
if: github.event_name == 'pull_request' && matrix.version == '21'
38+
uses: ./actions/package-size
39+
with:
40+
github_token: ${{ secrets.GITHUB_TOKEN }}
41+
target_file: 'packages/sdk/combined-browser/dist/index.js'
42+
package_name: '@launchdarkly/browser'
43+
pr_number: ${{ github.event.number }}
44+
size_limit: 200000

.github/workflows/manual-publish-docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ on:
2323
- packages/sdk/browser
2424
- packages/sdk/server-ai
2525
- packages/telemetry/browser-telemetry
26+
- packages/sdk/combined-browser
2627
name: Publish Documentation
2728
jobs:
2829
build-publish:

.github/workflows/manual-publish.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ on:
3636
- packages/sdk/browser
3737
- packages/sdk/server-ai
3838
- packages/telemetry/browser-telemetry
39+
- packages/sdk/combined-browser
3940
prerelease:
4041
description: 'Is this a prerelease. If so, then the latest tag will not be updated in npm.'
4142
type: boolean

.github/workflows/release-please.yml

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ jobs:
2828
package-browser-released: ${{ steps.release.outputs['packages/sdk/browser--release_created'] }}
2929
package-server-ai-released: ${{ steps.release.outputs['packages/sdk/server-ai--release_created'] }}
3030
package-browser-telemetry-released: ${{ steps.release.outputs['packages/telemetry/browser-telemetry--release_created'] }}
31+
package-combined-browser-released: ${{ steps.release.outputs['packages/sdk/combined-browser--release_created'] }}
3132
steps:
3233
- uses: googleapis/release-please-action@v4
3334
id: release
@@ -207,7 +208,7 @@ jobs:
207208
with:
208209
node-version: 22.x
209210
registry-url: 'https://registry.npmjs.org'
210-
- id: release-react-native
211+
- id: release-browser
211212
name: Full release of packages/sdk/browser
212213
uses: ./actions/full-release
213214
with:
@@ -439,3 +440,23 @@ jobs:
439440
with:
440441
workspace_path: packages/telemetry/browser-telemetry
441442
aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
443+
444+
release-combined-browser:
445+
runs-on: ubuntu-latest
446+
needs: ['release-please', 'release-browser']
447+
permissions:
448+
id-token: write
449+
contents: write
450+
if: ${{ always() && !failure() && !cancelled() && needs.release-please.outputs.package-combined-browser-released == 'true'}}
451+
steps:
452+
- uses: actions/checkout@v4
453+
- uses: actions/setup-node@v4
454+
with:
455+
node-version: 22.x
456+
registry-url: 'https://registry.npmjs.org'
457+
- id: release-combined-browser
458+
name: Full release of packages/sdk/combined-browser
459+
uses: ./actions/full-release
460+
with:
461+
workspace_path: packages/sdk/combined-browser
462+
aws_assume_role: ${{ vars.AWS_ROLE_ARN }}

.release-please-manifest.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,6 @@
1717
"packages/sdk/browser": "0.7.1",
1818
"packages/sdk/server-ai": "0.9.8",
1919
"packages/telemetry/browser-telemetry": "1.0.9",
20-
"packages/tooling/jest": "0.1.8"
20+
"packages/tooling/jest": "0.1.8",
21+
"packages/sdk/combined-browser": "0.0.0"
2122
}

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ This includes shared libraries, used by SDKs and other tools, as well as SDKs.
1616
| [@launchdarkly/react-native-client-sdk](packages/sdk/react-native/README.md) | [![NPM][sdk-react-native-npm-badge]][sdk-react-native-npm-link] | [React-Native][package-sdk-react-native-issues] | [![Actions Status][sdk-react-native-ci-badge]][sdk-react-native-ci] |
1717
| [@launchdarkly/js-client-sdk](packages/sdk/browser/README.md) | [![NPM][sdk-browser-npm-badge]][sdk-browser-npm-link] | [Browser][package-sdk-browser-issues] | [![Actions Status][sdk-browser-ci-badge]][sdk-browser-ci] |
1818
| [@launchdarkly/server-sdk-ai](packages/sdk/server-ai/README.md) | [![NPM][sdk-server-ai-npm-badge]][sdk-server-ai-npm-link] | [server-ai][package-sdk-server-ai-issues] | [![Actions Status][sdk-server-ai-ci-badge]][sdk-server-ai-ci] |
19+
<!--| [@launchdarkly/browser](packages/sdk/combined-browser/README.md) | [![NPM][sdk-combined-browser-npm-badge]][sdk-browser-npm-link] | [Combined Browser][package-sdk-combined-browser-issues] | [![Actions Status][sdk-combined-browser-ci-badge]][sdk-combined-browser-ci] |-->
1920

2021
| Shared packages | npm | issues | tests |
2122
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------- |
@@ -209,3 +210,13 @@ We encourage pull requests and other contributions from the community. Check out
209210
[browser-telemetry-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/browser-telemetry.svg?style=flat-square
210211
[browser-telemetry-npm-link]: https://www.npmjs.com/package/@launchdarkly/browser-telemetry
211212
[browser-telemetry-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+telemetry%2Fbrowser-telemetry%22+
213+
[//]: # 'sdk/combined-browser'
214+
[sdk-combined-browser-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/combined-browser.yml/badge.svg
215+
[sdk-combined-browser-ci]: https://github.com/launchdarkly/js-core/actions/workflows/combined-browser.yml
216+
[sdk-combined-browser-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/browser.svg?style=flat-square
217+
[sdk-combined-browser-npm-link]: https://www.npmjs.com/package/@launchdarkly/browser
218+
[sdk-combined-browser-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
219+
[sdk-combined-browser-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/combined-browser/docs/
220+
[sdk-combined-browser-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/browser.svg?style=flat-square
221+
[sdk-combined-browser-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/browser.svg?style=flat-square
222+
[package-sdk-browser-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fcombined-browser%22+

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
"packages/sdk/server-ai/examples/bedrock",
3535
"packages/sdk/server-ai/examples/openai",
3636
"packages/telemetry/browser-telemetry",
37-
"contract-tests"
37+
"contract-tests",
38+
"packages/sdk/combined-browser"
3839
],
3940
"private": true,
4041
"scripts": {

packages/sdk/combined-browser/CHANGELOG.md

Whitespace-only changes.

0 commit comments

Comments
 (0)