Skip to content

Commit

Permalink
fix: Release please handle versioning (#47)
Browse files Browse the repository at this point in the history
Signed-off-by: Nicklas Lundin <[email protected]>
  • Loading branch information
nicklasl authored Oct 10, 2023
1 parent 4cfef58 commit bc249c5
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 10 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/release_please.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 🗳
Expand Down
4 changes: 3 additions & 1 deletion OpenFeature/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,27 +41,36 @@ 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)

<!-- x-release-please-start-version -->
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`.

You can now add the OpenFeature SDK dependency:
```kotlin
dependencies {
api("com.github.open-feature:kotlin-sdk:<Latest>")
api("com.github.open-feature:kotlin-sdk:0.0.2")
}
```
Please note that the `<Latest>` can be any `Commit SHA` or a version based on a branch as follows:
<!-- x-release-please-end -->
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
Expand Down
6 changes: 5 additions & 1 deletion release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down

0 comments on commit bc249c5

Please sign in to comment.