chore: Upload artifacts from Github CI (#3)

* chore: Upload artifacts from github CI

* rework workflow files

* add info to readme

* rename job

* fix signing config

* expose env vars

* minor fixes

* fix release worklow version

Author: felipecsl

.github/workflows/lint-test-sdk.yml

@@ -5,6 +5,10 @@ on:
     paths:
       - '**/*'
 
+env:
+  ORG_GRADLE_PROJECT_ossrhUsername: ${{ secrets.OSSRH_USERNAME }}
+  ORG_GRADLE_PROJECT_ossrhPassword: ${{ secrets.OSSRH_PASSWORD }}
+
 jobs:
   lint-test-sdk:
     runs-on: ubuntu-latest
@@ -21,9 +25,8 @@ jobs:
         with:
           java-version: ${{ matrix.java-version }}
           distribution: 'adopt'
+          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+          gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
 
       - name: Run tests
-        run: ./gradlew check
-        env:
-          ORG_GRADLE_PROJECT_ossrhUsername: ${{ secrets.OSSRH_USERNAME }}
-          ORG_GRADLE_PROJECT_ossrhPassword: ${{ secrets.OSSRH_PASSWORD }}
+        run: ./gradlew check --no-daemon

.github/workflows/publish-sdk.yml

@@ -1,7 +1,13 @@
-name: Publish sdk to the Maven Central Repository
+name: Publish release SDK to the Maven Central Repository
+
 on:
   release:
     types: [published]
+
+env:
+  ORG_GRADLE_PROJECT_ossrhUsername: ${{ secrets.OSSRH_USERNAME }}
+  ORG_GRADLE_PROJECT_ossrhPassword: ${{ secrets.OSSRH_PASSWORD }}
+
 jobs:
   publish:
     runs-on: ubuntu-latest
@@ -14,24 +20,14 @@ jobs:
           java-version: '8'
           distribution: 'temurin'
           server-id: ossrh
-          server-username: MAVEN_USERNAME
-          server-password: MAVEN_PASSWORD
           gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
-          gpg-passphrase: GPG_PASSPHRASE
+          gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
 
       - name: Download test data
         run: make test-data
 
-      - name: Publish package with debug logging
-        run: mvn --batch-mode deploy -X
-        env:
-          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
-          MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
-          GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
-
-      - name: Release the staging repository
-        run: mvn nexus-staging:release -X
+      - name: Publish to Maven Central
+        run: ./gradlew publish --no-daemon
         env:
-          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
-          MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
+          GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
           GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

.github/workflows/publish-snapshot.yml

@@ -0,0 +1,31 @@
+name: Publish SDK Snapshot artifact
+
+on:
+  push:
+    branches: [main]
+
+env:
+  ORG_GRADLE_PROJECT_ossrhUsername: ${{ secrets.OSSRH_USERNAME }}
+  ORG_GRADLE_PROJECT_ossrhPassword: ${{ secrets.OSSRH_PASSWORD }}
+
+jobs:
+  publish-snapshot:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: 'adopt'
+          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+          gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
+
+      - name: Publish Snapshot artifact
+        run: ./gradlew publish --no-daemon
+        env:
+          GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
+          GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

README.md

@@ -1,4 +1,38 @@
 # Eppo JVM common SDK
 
-This is the common SDK for the Eppo JVM. It provides a set of classes and interfaces that are used by the Eppo JVM to 
-interact with the Eppo API.
+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](https://github.com/Eppo-exp/android-sdk)
+or [JVM](https://github.com/Eppo-exp/java-server-sdk) SDKs.
+
+# Usage
+
+## build.gradle:
+
+```groovy
+dependencies {
+  implementation 'cloud.eppo:sdk-common-jvm:1.0.0'
+}
+```
+
+# Releasing a new version
+
+Bump the project version in `build.gradle`
+To release a new version of the SDK, you need to create a new tag in the repository. The tag should be named `vX.Y.Z`,
+where `X.Y.Z` is the version number of the release. For example, if you are releasing version 1.2.3, the tag should be
+named `v1.2.3`.
+
+# 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:
+
+```groovy
+repositories {
+  maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots" }
+}
+
+dependencies {
+  implementation 'cloud.eppo:sdk-common-jvm:1.0.0-SNAPSHOT'
+}
+```

build.gradle

@@ -107,6 +107,7 @@ publishing {
 
 signing {
   sign publishing.publications.mavenJava
+  useInMemoryPgpKeys(System.env.GPG_PRIVATE_KEY, System.env.GPG_PASSPHRASE)
 }