Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2 KB

README.md

File metadata and controls

60 lines (41 loc) · 2 KB
Raw

Eppo Server-Side SDK for Java

Usage

build.gradle:

dependencies {
  implementation 'cloud.eppo:eppo-server-sdk:3.1.0'
}

Refer to our SDK documentation for how to install and use the SDK.

Contributing

Java 8 is required to locally compile the SDK.

Apple M-Series

Download a arm64 compatible build: https://www.azul.com/downloads/?version=java-8-lts&architecture=arm-64-bit&package=jdk#zulu

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. Snapshots are published automatically after each push to main branch.

build.gradle:

repositories {
  maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots" }
}

dependencies {
  implementation 'cloud.eppo:eppo-server-sdk:3.0.2-SNAPSHOT'
}