Skip to content

Commit bc69bdd

Browse files
authored
fix: react prerelease docs (#1215)
Moving the react sdk to pre-release stage. <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/launchdarkly/js-core/pull/1215" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open with Devin"> </picture> </a> <!-- devin-review-badge-end --> <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: documentation-only changes plus a small `release-please-config.json` tweak that only affects automated release generation for `packages/sdk/react`. > > **Overview** > Marks `@launchdarkly/react-sdk` more explicitly as *pre-release* by updating `README.md` with badges and stronger caution text (including upgrade guidance and changelog pointer). > > Cleans up the React SDK `CHANGELOG.md` entry by removing previously listed dependency/security fix sections, and removes the `bootstrap-sha` override for `packages/sdk/react` in `release-please-config.json`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 2a4bcb5. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent d93ccef commit bc69bdd

3 files changed

Lines changed: 24 additions & 19 deletions

File tree

packages/sdk/react/CHANGELOG.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,3 @@
66
### Features
77

88
* pre-release of `@launchdarkly/react-sdk` ([#1201](https://github.com/launchdarkly/js-core/issues/1201)) ([69f4790](https://github.com/launchdarkly/js-core/commit/69f47902f5327d3d7c7f1bbca66a3d0ff95e7452))
9-
10-
11-
### Bug Fixes
12-
13-
* **deps:** update dependency next to v16.1.5 [security] ([#1164](https://github.com/launchdarkly/js-core/issues/1164)) ([929a385](https://github.com/launchdarkly/js-core/commit/929a385568b7b25e2340c5e7b4f654e6b6d8d907))
14-
* **deps:** update dependency next to v16.1.7 [security] ([#1196](https://github.com/launchdarkly/js-core/issues/1196)) ([1572be1](https://github.com/launchdarkly/js-core/commit/1572be1adbb25eb12102e5f03dd058d62423afb3))
15-
16-
17-
### Dependencies
18-
19-
* The following workspace dependencies were updated
20-
* dependencies
21-
* @launchdarkly/js-client-sdk bumped from ^4.4.0 to ^4.4.1
22-
* @launchdarkly/js-server-sdk-common bumped from ^2.18.2 to ^2.18.3

packages/sdk/react/README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
# LaunchDarkly React SDK
22

3+
[![NPM][react-sdk-npm-badge]][react-sdk-npm-link]
4+
[![Actions Status][react-sdk-ci-badge]][react-sdk-ci]
5+
[![Documentation][react-sdk-ghp-badge]][react-sdk-ghp-link]
6+
[![NPM][react-sdk-dm-badge]][react-sdk-npm-link]
7+
[![NPM][react-sdk-dt-badge]][react-sdk-npm-link]
8+
9+
⚠️⚠️⚠️
10+
311
> [!CAUTION]
4-
> This [SDK|feature] is experimental and should NOT be considered ready for production use.
5-
> It may change or be removed without notice and is not subject to backwards
6-
> compatibility guarantees.
12+
> This SDK is in pre-release and not subject to backwards compatibility
13+
> guarantees. The API may change based on feedback.
14+
>
15+
> Pin to a specific minor version and review the [changelog](./CHANGELOG.md) before upgrading.
16+
17+
☝️☝️☝️
718

819
## About LaunchDarkly
920

@@ -19,3 +30,12 @@
1930
- [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides
2031
- [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
2132
- [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
33+
34+
[react-sdk-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/react.yml/badge.svg
35+
[react-sdk-ci]: https://github.com/launchdarkly/js-core/actions/workflows/react.yml
36+
[react-sdk-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/react-sdk.svg?style=flat-square
37+
[react-sdk-npm-link]: https://www.npmjs.com/package/@launchdarkly/react-sdk
38+
[react-sdk-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
39+
[react-sdk-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/react/docs/
40+
[react-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/react-sdk.svg?style=flat-square
41+
[react-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/react-sdk.svg?style=flat-square

release-please-config.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,7 @@
104104
"bump-minor-pre-major": true
105105
},
106106
"packages/sdk/react": {
107-
"bump-minor-pre-major": true,
108-
"bootstrap-sha": "9250766a9"
107+
"bump-minor-pre-major": true
109108
}
110109
},
111110
"plugins": [

0 commit comments

Comments
 (0)