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

docs: Resolve latest SDK versions at build time #4767

Merged
merged 12 commits into from
Oct 31, 2024
23 changes: 8 additions & 15 deletions docs/docs/clients/client-side/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,36 +5,29 @@ description: Manage your Feature Flags and Remote Config in your Android applica
slug: /clients/android
---

import CodeBlock from '@theme/CodeBlock'; import { AndroidVersion } from '@site/src/components/SdkVersions.js';

This SDK can be used for Android applications written in Kotlin. The source code for the client is available on
[GitHub](https://github.com/Flagsmith/flagsmith-kotlin-android-client/).

## Installation

### Gradle - App

In your project path `app/build.gradle` add a new dependence

```groovy
//flagsmith
implementation("com.github.Flagsmith:flagsmith-kotlin-android-client:v1.6.1")
```

You should be able to find the latest version in the
[releases section](https://github.com/Flagsmith/flagsmith-kotlin-android-client/releases) of the GitHub repository.

### Gradle - Project
### Gradle

In the new Gradle version 7+ update your `settings.gradle` file to include JitPack if you haven't already
Make sure your `settings.gradle` includes JitPack as a repository:

```groovy
repositories {
google()
mavenCentral()

maven("https://jitpack.io")
}
```

In your project path `app/build.gradle` add a new dependency:

<CodeBlock>{`implementation("com.flagsmith:flagsmith-kotlin-android-client:v`}<AndroidVersion />"{`)`}</CodeBlock>

## Basic Usage

The SDK is initialised against a single environment within a project on [https://flagsmith.com](https://flagsmith.com),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ description: Manage your Feature Flags and Remote Config in your iOS application
slug: /clients/ios
---

import CodeBlock from '@theme/CodeBlock';
import { IOSVersion } from '@site/src/components/SdkVersions.js';

This library can be used with iOS and Mac applications. The source code for the client is available on
[GitHub](https://github.com/flagsmith/flagsmith-ios-client).

Expand All @@ -15,20 +18,24 @@ This library can be used with iOS and Mac applications. The source code for the
[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions,
visit their website. To integrate Flagsmith into your Xcode project using CocoaPods, specify it in your `Podfile`:

```ruby
pod 'FlagsmithClient', '~> 1.0'
```
<CodeBlock>
{`pod 'FlagsmithClient', '~> `}
<IOSVersion />
{`'`}
</CodeBlock>

### Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift
compiler. You can use it to install Flagsmith by adding the description to your `Package.swift` file:

```swift
dependencies: [
.package(url: "https://github.com/Flagsmith/flagsmith-ios-client.git", from: "1.1.1"),
]
```
<CodeBlock>
{`dependencies: [
.package(url: "https://github.com/Flagsmith/flagsmith-ios-client.git", from: "`}
<IOSVersion />
{`"),
]`}
</CodeBlock>

## Basic Usage

Expand Down Expand Up @@ -72,8 +79,8 @@ Flagsmith.shared.getFeatureFlags() { (result) in

Note that you can use:

- `flag.value?.stringValue`
- `flag.value?.intValue`
- `flag.value?.stringValue`
- `flag.value?.intValue`

Based on your desired type.

Expand Down
5 changes: 2 additions & 3 deletions docs/docs/clients/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Read more about our Client-side SDKs for your language/platform:

## Server-side SDKs

[Server-side SDKs](/clients/server-side.md) run within _trusted environments_ - typically the server infrastructure that
[Server-side SDKs](/clients/server-side) run within _trusted environments_ - typically the server infrastructure that
you have control over. Because of this, you should not share your Server-side Environment keys publicly; they should be
treated as secret.

Expand Down Expand Up @@ -82,8 +82,7 @@ the Flag Engine, and the engine runs within your server environment within the F
![Local Evaluation Diagram](/img/sdk-local-evaluation.svg)

You have to configure the SDK to run in Local Evaluation mode. See the
[SDK configuration options](server-side.md#configuring-the-sdk) for details on how to do that in your particular
language.
[SDK configuration options](server-side#configuring-the-sdk) for details on how to do that in your particular language.

When the SDK is initialised in Local Evaluation mode, it grabs the entire set of details about the Environment from the
Flagsmith API. For a given Environment, this includes:
Expand Down
Loading