Skip to content
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 sdk readmes #882

Merged
merged 1 commit into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 33 additions & 6 deletions docs/reference/technologies/client/kotlin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ This content has been automatically generated from kotlin-sdk.
Edits should be made here: https://github.com/open-feature/kotlin-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:55 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
<a href="https://github.com/open-feature/spec/releases/tag/v0.6.0">
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.6.0&color=yellow&style=for-the-badge" />
</a>

<a href="https://github.com/open-feature/kotlin-sdk/releases/tag/v0.3.0">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.3.0&color=blue&style=for-the-badge" />
<a href="https://github.com/open-feature/kotlin-sdk/releases/tag/v0.3.2">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.3.2&color=blue&style=for-the-badge" />
</a>

<br/>
Expand All @@ -45,7 +45,7 @@ Installation via Maven Central is preferred, using the following dependency:

```kotlin
dependencies {
api("dev.openfeature:android-sdk:0.3.0")
api("dev.openfeature:android-sdk:0.3.2")
}
```

Expand All @@ -65,15 +65,16 @@ coroutineScope.launch(Dispatchers.IO) {
## Features

| Status | Features | Description |
| ------ | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|--------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| ✅ | [Providers](#providers) | Integrate with a commercial, open source, or in-house feature management tool. |
| ✅ | [Targeting](#targeting) | Contextually-aware flag evaluation using [evaluation context](/docs/reference/concepts/evaluation-context). |
| ✅ | [Hooks](#hooks) | Add functionality to various stages of the flag evaluation life-cycle. |
| ✅ | [Tracking](#tracking) | Associate user actions with feature flag evaluations. |
| ❌ | [Logging](#logging) | Integrate with popular logging packages. |
| ❌ | [Named clients](#named-clients) | Utilize multiple providers in a single application. |
| ✅ | [Eventing](#eventing) | React to state changes in the provider or flag management system. |
| ✅ | [Shutdown](#shutdown) | Gracefully clean up a provider during application shutdown. |
| ⚠️ | [Extending](#extending) | Extend OpenFeature with custom providers and hooks. |
| ⚠️ | [Extending](#extending) | Extend OpenFeature with custom providers and hooks. |

<sub>Implemented: ✅ | In-progress: ⚠️ | Not implemented yet: ❌</sub>

Expand Down Expand Up @@ -125,6 +126,32 @@ client.addHooks(listOf(ExampleHook()))
val retval = client.getBooleanValue(flagKey, false,
FlagEvaluationOptions(listOf(ExampleHook())))
```

### Tracking

The [tracking API](/specification/sections/tracking/) allows you to use
OpenFeature abstractions to associate user actions with feature flag evaluations.
This is essential for robust experimentation powered by feature flags. Note that, unlike methods
that handle feature flag evaluations, calling `track(...)` may throw an `IllegalArgumentException`
if an empty string is passed as the `trackingEventName`.

Below is an example of how we can track a "Checkout" event with some `TrackingDetails`.

```kotlin
OpenFeatureAPI.getClient().track(
"Checkout",
TrackingEventDetails(
499.99,
ImmutableStructure(
"numberOfItems" to Value.Integer(4),
"timeInCheckout" to Value.String("PT3M20S")
)
)
)
```

Tracking is optionally implemented by Providers.

### Logging

Logging customization is not yet available in the Kotlin SDK.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/client/swift.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This content has been automatically generated from swift-sdk.
Edits should be made here: https://github.com/open-feature/swift-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:40 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:55 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/client/web/angular.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
Edits should be made here: https://github.com/open-feature/js-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:40 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:55 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/technologies/client/web/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ This content has been automatically generated from js-sdk.
Edits should be made here: https://github.com/open-feature/js-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:54 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
</a>

<a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.3.2">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.3.2&color=blue&style=for-the-badge" />
<a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.4.0">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.4.0&color=blue&style=for-the-badge" />
</a>

<br/>
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/technologies/client/web/react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ This content has been automatically generated from js-sdk.
Edits should be made here: https://github.com/open-feature/js-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:55 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
</a>

<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.4.9">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.4.9&color=blue&style=for-the-badge" />
<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.4.10">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.4.10&color=blue&style=for-the-badge" />
</a>

<br/>
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/technologies/server/dotnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This content has been automatically generated from dotnet-sdk.
Edits should be made here: https://github.com/open-feature/dotnet-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:54 GMT+0000 (Coordinated Universal Time)
-->

[![Specification](https://img.shields.io/static/v1?label=specification&message=v0.7.0&color=yellow&style=for-the-badge)](https://github.com/open-feature/spec/releases/tag/v0.7.0)
Expand All @@ -27,8 +27,7 @@ Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time)

### Requirements

- .NET 6+
- .NET Core 6+
- .NET 8+
- .NET Framework 4.6.2+

Note that the packages will aim to support all current .NET versions. Refer to the currently supported versions [.NET](https://dotnet.microsoft.com/download/dotnet) and [.NET Framework](https://dotnet.microsoft.com/download/dotnet-framework) excluding .NET Framework 3.5
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/go.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This content has been automatically generated from go-sdk.
Edits should be made here: https://github.com/open-feature/go-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:54 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/java.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This content has been automatically generated from java-sdk.
Edits should be made here: https://github.com/open-feature/java-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:37 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:54 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/technologies/server/javascript/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ This content has been automatically generated from js-sdk.
Edits should be made here: https://github.com/open-feature/js-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:54 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
</a>

<a href="https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.16.2">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.16.2&color=blue&style=for-the-badge" />
<a href="https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.17.0">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.17.0&color=blue&style=for-the-badge" />
</a>

<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/javascript/nestjs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
Edits should be made here: https://github.com/open-feature/js-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:54 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/php.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This content has been automatically generated from php-sdk.
Edits should be made here: https://github.com/open-feature/php-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:54 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This content has been automatically generated from python-sdk.
Edits should be made here: https://github.com/open-feature/python-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:54 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/ruby.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This content has been automatically generated from ruby-sdk.
Edits should be made here: https://github.com/open-feature/ruby-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Tue Dec 17 2024 08:10:40 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jan 02 2025 08:08:55 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
16 changes: 8 additions & 8 deletions src/datasets/sdks/sdk-compatibility.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@
"path": "/docs/reference/technologies/server/javascript",
"category": "Server",
"release": {
"href": "https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.16.2",
"version": "1.16.2",
"href": "https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.17.0",
"version": "1.17.0",
"stable": true
},
"spec": {
Expand Down Expand Up @@ -340,8 +340,8 @@
"path": "/docs/reference/technologies/client/web",
"category": "Client",
"release": {
"href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.3.2",
"version": "1.3.2",
"href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.4.0",
"version": "1.4.0",
"stable": true
},
"spec": {
Expand Down Expand Up @@ -392,8 +392,8 @@
"path": "/docs/reference/technologies/client/kotlin",
"category": "Client",
"release": {
"href": "https://github.com/open-feature/kotlin-sdk/releases/tag/v0.3.0",
"version": "0.3.0",
"href": "https://github.com/open-feature/kotlin-sdk/releases/tag/v0.3.2",
"version": "0.3.2",
"stable": false
},
"spec": {
Expand Down Expand Up @@ -426,8 +426,8 @@
"path": "/docs/reference/technologies/client/kotlin#eventing"
},
"Tracking": {
"status": "",
"path": "/docs/reference/technologies/client/kotlin"
"status": "",
"path": "/docs/reference/technologies/client/kotlin#tracking"
},
"Shutdown": {
"status": "✅",
Expand Down
Loading