chore: Prepare for release v1.0.0 (#4)

* chore: Prepare for release v1.0.0

* more readme and project release tweaks

* fix syntax

* more formatting

* add link for GPG config instructions

* better steps

Author: felipecsl

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

@@ -8,6 +8,7 @@ on:
 env:
   ORG_GRADLE_PROJECT_ossrhUsername: ${{ secrets.OSSRH_USERNAME }}
   ORG_GRADLE_PROJECT_ossrhPassword: ${{ secrets.OSSRH_PASSWORD }}
+  CI: true
 
 jobs:
   lint-test-sdk:

.github/workflows/publish-sdk.yml

@@ -7,6 +7,7 @@ on:
 env:
   ORG_GRADLE_PROJECT_ossrhUsername: ${{ secrets.OSSRH_USERNAME }}
   ORG_GRADLE_PROJECT_ossrhPassword: ${{ secrets.OSSRH_PASSWORD }}
+  CI: true
 
 jobs:
   publish:
@@ -23,9 +24,6 @@ jobs:
           gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
           gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
 
-      - name: Download test data
-        run: make test-data
-
       - name: Publish to Maven Central
         run: ./gradlew publish --no-daemon
         env:

.github/workflows/publish-snapshot.yml

@@ -7,6 +7,7 @@ on:
 env:
   ORG_GRADLE_PROJECT_ossrhUsername: ${{ secrets.OSSRH_USERNAME }}
   ORG_GRADLE_PROJECT_ossrhPassword: ${{ secrets.OSSRH_PASSWORD }}
+  CI: true
 
 jobs:
   publish-snapshot:
@@ -25,7 +26,7 @@ jobs:
           gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
 
       - name: Publish Snapshot artifact
-        run: ./gradlew publish --no-daemon
+        run: ./gradlew check publish --no-daemon
         env:
           GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
           GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

README.md

@@ -4,28 +4,44 @@ This is the common SDK for the Eppo JVM SDKs. It provides a set of classes and i
 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
+## Usage
 
-## build.gradle:
+### build.gradle:
 
 ```groovy
 dependencies {
   implementation 'cloud.eppo:sdk-common-jvm:1.0.0'
 }
 ```
 
-# Releasing a new version
+## 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`.
+For publishing a release locally, follow the steps below.
+
+### Prerequisites
+
+1. [Generate a user token](https://central.sonatype.org/publish/generate-token/) on `s01.oss.sonatype.org`;
+2. [Configure a GPG key](https://central.sonatype.org/publish/requirements/gpg/) 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](https://central.sonatype.org/publish/release/#credentials) to promote your release
+
+## Using Snapshots
 
-# 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:
+### build.gradle:
 
 ```groovy
 repositories {

build.gradle

@@ -6,7 +6,7 @@ plugins {
 }
 
 group = 'cloud.eppo'
-version = '1.0.0-SNAPSHOT'
+version = '2.0.0-SNAPSHOT'
 ext.isReleaseVersion = !version.endsWith("SNAPSHOT")
 
 dependencies {
@@ -107,7 +107,9 @@ publishing {
 
 signing {
   sign publishing.publications.mavenJava
-  useInMemoryPgpKeys(System.env.GPG_PRIVATE_KEY, System.env.GPG_PASSPHRASE)
+  if (System.env['CI']) {
+    useInMemoryPgpKeys(System.env.GPG_PRIVATE_KEY, System.env.GPG_PASSPHRASE)
+  }
 }