Skip to content
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
6 changes: 3 additions & 3 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout latest code
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Set up JDK 11
uses: actions/setup-java@v3
uses: actions/setup-java@v4
with:
distribution: "adopt"
java-version: 11

- name: Setup build cache
uses: actions/cache@v3.0.2
uses: actions/cache@v4
with:
path: ~/.gradle/caches
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle.kts') }}
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ jobs:

steps:
- name: Checkout latest code
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Set up JDK 11
uses: actions/setup-java@v3
uses: actions/setup-java@v4
with:
distribution: "adopt"
java-version: 11

- name: Setup build cache
uses: actions/cache@v3.0.2
uses: actions/cache@v4
with:
path: ~/.gradle/caches
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle.kts') }}
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@ We are breaking down the various parts that we need to migrate to Swift in the s
| | `fetchDatafileContent` | |
| | `getValueByType` | |

### Releasing

See [RELEASE.md](./RELEASE.md) for how to cut and publish a new version.

### Test runner

We should also have an executable as an output of this repository that can be used to run the test specs against the Kotlin SDK: https://featurevisor.com/docs/testing/
Expand Down
22 changes: 22 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Releasing

To cut a new release:

1. Decide on the next version number (plain numbering, no `v` prefix, e.g. `0.0.23`).
2. Create and publish a GitHub Release with a tag matching that version, e.g. `gh release create 0.0.23 --title 0.0.23 --generate-notes`.
3. Done — no manual build/publish step needed.

## How it works

Publishing the release triggers [`.github/workflows/publish.yml`](./.github/workflows/publish.yml), which runs `./gradlew -Pversion=<tag> publish` and pushes the artifact to GitHub Packages.

Separately, and independently of that workflow, [JitPack](https://jitpack.io/#featurevisor/featurevisor-kotlin) builds the same tag on demand the first time someone resolves that version — it only needs the tag to exist, not any CI to run.

## Distribution channels

- **JitPack** — what the [README's Installation section](./README.md#installation) tells consumers to use (`com.github.featurevisor:featurevisor-kotlin:<version>` via `https://jitpack.io`). This is also what the only known consumer actually uses.
- **GitHub Packages** — published to `https://maven.pkg.github.com/featurevisor/featurevisor-kotlin` by CI on every release. Requires authenticating to GitHub Packages to consume.

## Notes

- The "Latest" release marked on GitHub is currently `0.0.11`, while `0.0.12`–`0.0.22` are marked as pre-releases.
2 changes: 1 addition & 1 deletion codestyle/codestyle.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ val someVariable = "asd"

## Empty statements or lambdas

We want to make sure that empty or blank statements are not left there by accident, that's why you need to use `doNothing()` function from `com.dazn.extensions` for marking it as intentionally empty.
We want to make sure that empty or blank statements are not left there by accident, that's why you need to use a `doNothing()` function for marking it as intentionally empty.

```kotlin
when (x) {
Expand Down
Loading