diff --git a/.github/workflows/release_please.yaml b/.github/workflows/release_please.yaml index 5d312bd..816e134 100644 --- a/.github/workflows/release_please.yaml +++ b/.github/workflows/release_please.yaml @@ -58,8 +58,6 @@ jobs: run: chmod +x gradlew - name: Build AAR ⚙️🛠 - env: - OF_KOTLIN_RELEASE_VERSION: ${{ needs.release-please.outputs.version }} run: bash ./gradlew :openfeature:assemble - name: Upload Openfeature SDK AAR 🗳 diff --git a/OpenFeature/build.gradle.kts b/OpenFeature/build.gradle.kts index b635133..f9b8ae7 100644 --- a/OpenFeature/build.gradle.kts +++ b/OpenFeature/build.gradle.kts @@ -7,7 +7,9 @@ plugins { kotlin("plugin.serialization") version "1.9.10" } -val releaseVersion = System.getenv("OF_KOTLIN_RELEASE_VERSION") ?: "0.0.1-SNAPSHOT" +// x-release-please-start-version +val releaseVersion = "0.0.2" +// x-release-please-end android { namespace = "dev.openfeature.sdk" diff --git a/README.md b/README.md index 2f322de..01043eb 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,18 @@ Note that this library is intended to be used in a mobile context, and has not b ### Install +#### Maven Central + +Installation via Maven Central is currently [WIP](https://github.com/open-feature/kotlin-sdk/issues/37) + + +You can add the OpenFeature SDK dependency: +```kotlin +dependencies { + api("com.github.open-feature:kotlin-sdk:0.0.2") +} +``` + #### Jitpack The Android project must include `maven("https://jitpack.io")` in `settings.gradle`. @@ -48,20 +60,17 @@ The Android project must include `maven("https://jitpack.io")` in `settings.grad You can now add the OpenFeature SDK dependency: ```kotlin dependencies { - api("com.github.open-feature:kotlin-sdk:") + api("com.github.open-feature:kotlin-sdk:0.0.2") } ``` -Please note that the `` can be any `Commit SHA` or a version based on a branch as follows: + +Please note that the `version` can be any `Commit SHA` or a version based on a branch as follows: ``` api("com.github.open-feature:kotlin-sdk:[ANY_BRANCH]-SNAPSHOT") ``` This will get a build from the head of the mentioned branch. -#### Maven - -Installation via Maven Central is currently [WIP](https://github.com/open-feature/kotlin-sdk/issues/37) - ### Usage ```kotlin diff --git a/release-please-config.json b/release-please-config.json index ed72de1..8f59758 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -5,7 +5,11 @@ "release-type": "simple", "bump-minor-pre-major": true, "bump-patch-for-minor-pre-major": true, - "versioning": "default" + "versioning": "default", + "extra-files": [ + "README.md", + "OpenFeature/build.gradle.kts" + ] } }, "changelog-sections": [