Eppo JVM common SDK

This is the common SDK for the Eppo JVM SDKs. It provides a set of classes and interfaces that are used by the SDKs to interact with the Eppo API. You should probably not use this library directly and instead use the Android or JVM SDKs.

Usage

build.gradle:

dependencies {
  implementation 'cloud.eppo:sdk-common-jvm:4.0.0'
}

Releasing a new version

For publishing a release locally, follow the steps below.

Prerequisites

1. Generate a user token on s01.oss.sonatype.org;
2. Configure a GPG key for signing the artifact. Don't forget to upload it to the key server;
3. Make sure you have the following vars in your ~/.gradle/gradle.properties file:
   1. ossrhUsername - User token username for Sonatype generated in step 1
   2. ossrhPassword - User token password for Sonatype generated in step 1
   3. signing.keyId - GPG key ID generated in step 2
   4. signing.password - GPG key password generated in step 2
   5. signing.secretKeyRingFile - Path to GPG key file generated in step 2

Once you have the prerequisites, follow the steps below to release a new version:

1. Bump the project version in build.gradle
2. Run ./gradlew publish
3. Follow the steps in this page to promote your release

Using Snapshots

If you would like to live on the bleeding edge, you can try running against a snapshot build. Keep in mind that snapshots represent the most recent changes on master and may contain bugs.

build.gradle:

repositories {
  maven {
    url "https://central.sonatype.com/repository/maven-snapshots/"
  }
}

dependencies {
  implementation 'cloud.eppo:sdk-common-jvm:X.Y.Z-SNAPSHOT'
}

Publishing Snapshots

Snapshots are published automatically after each push to the main branch.

Publishing from an Unmerged Branch

To publish a snapshot from a branch that hasn't been merged to main yet (e.g., for testing in downstream SDKs):

1. Push your branch to the snapshot/* namespace:

   # From your feature branch
   git push origin HEAD:snapshot/my-feature
   
   # Or push an existing branch
   git push origin my-branch:snapshot/my-feature

2. This triggers the snapshot publish workflow, which will:

   • Run tests
   • Build and sign artifacts
   • Deploy to Maven Central Snapshots

3. Monitor the workflow at: Actions > Publish SDK Snapshot

4. Once published, use the snapshot in downstream projects by updating the version in build.gradle.

Note: The snapshot/* branch is only used to trigger the publish workflow. You can delete it after the snapshot is published:

git push origin --delete snapshot/my-feature