chore(package): publish to central portal setup (#87)

Description
Modify build gradle setup to include the jreleaser plugin for publishing this package to Central Portal. Also update our publish workflow. I have also added new secrets for the newly updated publish workflow.

New secrets:

GPG_PASSPHRASE
GPG_PRIVATE_KEY
GPG_PUBLIC_KEY
MAVEN_CENTRAL_PORTAL_PASSWORD
MAVEN_CENTRAL_PORTAL_USERNAME

New Vars:

MAVEN_CENTRAL_STAGE

Links
ENSC-2072

Author: gdulafactset

.github/workflows/publish.yml

@@ -9,10 +9,15 @@ jobs:
     name: Deploy to package index
     runs-on: ubuntu-24.04
     env:
-      MAVEN_SNAPSHOTS_URL: ${{ vars.OSSRH_SNAPSHOT_URL }}
-      MAVEN_RELEASES_URL: ${{ vars.OSSRH_RELEASE_URL }}
-      MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
-      MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
+      JRELEASER_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      JRELEASER_MAVENCENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_PORTAL_USERNAME }}
+      JRELEASER_MAVENCENTRAL_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PORTAL_PASSWORD }}
+      JRELEASER_NEXUS2_USERNAME: ${{ secrets.MAVEN_CENTRAL_PORTAL_USERNAME }}
+      JRELEASER_NEXUS2_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PORTAL_PASSWORD }}
+      JRELEASER_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
+      JRELEASER_GPG_SECRET_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
+      JRELEASER_GPG_PUBLIC_KEY: ${{ secrets.GPG_PUBLIC_KEY }}
+      JRELEASER_MAVENCENTRAL_STAGE: ${{ vars.MAVEN_CENTRAL_STAGE }} # Default is "FULL" https://jreleaser.org/guide/latest/reference/deploy/maven/maven-central.html#_staged_deployments
 
     steps:
       - name: Checkout repository
@@ -24,14 +29,15 @@ jobs:
           distribution: zulu
           java-version: "8"
 
-      - name: Decode signing key ring
-        run: |
-          mkdir -p ~/.gradle
-          echo "${{secrets.SIGNING_SECRET_KEY_RING_FILE}}" > ~/.gradle/secring.gpg.b64
-          base64 -d ~/.gradle/secring.gpg.b64 > ~/.gradle/secring.gpg
+      - name: Verify JReleaser configuration
+        run: ./gradlew jreleaserConfig
 
       - name: Clean build directory
         run: ./gradlew clean
 
-      - name: Publish
-        run: ./gradlew publish -Psigning.keyId=${{secrets.SIGNING_KEY_ID}} -Psigning.password=${{secrets.SIGNING_KEY_PASSWORD}} -Psigning.secretKeyRingFile=$(echo ~/.gradle/secring.gpg) --info --console plain
+      - name: Publish (Stage to local directory)
+        run: ./gradlew publish
+      
+      - name: Deploy and release
+        run: ./gradlew jreleaserFullRelease --stacktrace
+

README.md

@@ -37,7 +37,7 @@ repositories {
 }
 
 dependencies {
-    implementation "com.factset.sdk.eventdriven:factsettrading:2.0.0-SNAPSHOT"
+    implementation "com.factset.sdk.eventdriven:factsettrading:2.0.0"
 }
 ```
 
@@ -52,7 +52,7 @@ To be able to install snapshot releases of the sdk an additional repository must
     <repository>
         <id>sonatype</id>
         <name>sonatype-snapshot</name>
-        <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
+        <url>https://central.sonatype.com/repository/maven-snapshots/</url>
         <snapshots>
             <enabled>true</enabled>
         </snapshots>
@@ -69,7 +69,7 @@ To be able to install snapshot releases of the sdk an additional repository must
 repositories {
     mavenCentral()
     maven {
-        url = uri("https://oss.sonatype.org/content/repositories/snapshots/")
+        url = uri("https://central.sonatype.com/repository/maven-snapshots/")
         mavenContent {
             snapshotsOnly()
         }

build.gradle.kts

@@ -1,7 +1,10 @@
+import java.time.LocalDate
+
 plugins {
     java
     `maven-publish`
     signing
+    id("org.jreleaser") version "1.17.0"
 }
 
 group = "com.factset.sdk.eventdriven"
@@ -57,12 +60,13 @@ tasks.jar {
     }
 }
 
-// https://docs.gradle.org/current/userguide/publishing_maven.html
-publishing {
-    publications {
-        create<MavenPublication>("mavenJava") {
+val releasesRepoUrl = layout.buildDirectory.dir("repos/releases")
+val snapshotsRepoUrl = layout.buildDirectory.dir("repos/snapshots")
 
-            // dependencies
+// Configure publishing
+configure<PublishingExtension> {
+    publications {
+        register<MavenPublication>("maven") {
             from(components["java"])
 
             versionMapping {
@@ -77,22 +81,20 @@ publishing {
             pom {
                 name.set("FactSet Trading event-driven client library for Java")
                 description.set("Event-driven api client for the FactSet Trading API")
-                url.set("https://github.com/factset/enterprise-sdk-eventdriven-factsettrading-java")
+                url.set("https://github.com/factset/enterprise-sdk-eventdriven-factsettrading-java/")
                 licenses {
                     license {
                         name.set("The Apache License, Version 2.0'")
                         url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
                     }
                 }
-
                 developers {
                     developer {
                         id.set("enterprisesdk")
                         organization.set("FactSet")
                         organizationUrl.set("https://developer.factset.com")
                     }
                 }
-
                 scm {
                     connection.set("scm:git:git://github.com/factset/enterprise-sdk-eventdriven-factsettrading-java.git")
                     developerConnection.set("scm:git:ssh://factset/enterprise-sdk-eventdriven-factsettrading-java.git")
@@ -104,47 +106,56 @@ publishing {
 
     repositories {
         maven {
-            var releasesRepoUrlEnv = System.getenv("MAVEN_RELEASES_URL")
-            var snapshotsRepoUrlEnv = System.getenv("MAVEN_SNAPSHOTS_URL")
-            var usernameEnv = System.getenv("MAVEN_USERNAME")
-            var passwordEnv = System.getenv("MAVEN_PASSWORD")
-
-            if (releasesRepoUrlEnv == null) {
-                releasesRepoUrlEnv = ""
-                project.logger.error("MAVEN_RELEASES_URL not set")
-            }
-
-            if (snapshotsRepoUrlEnv == null) {
-                snapshotsRepoUrlEnv = ""
-                project.logger.error("MAVEN_SNAPSHOTS_URL not set")
-            }
+            // change URLs to point to your repos, e.g. http://my.org/repo
+            url = if (version.toString().endsWith("SNAPSHOT")) uri(snapshotsRepoUrl) else uri(releasesRepoUrl)
+        }
+    }
+}
 
-            if (usernameEnv == null) {
-                usernameEnv = ""
-                project.logger.error("MAVEN_USERNAME not set")
-            }
+configure<org.jreleaser.gradle.plugin.JReleaserExtension> {
+    gitRootSearch.set(true)
+    project {
+        description = "Event-driven api client for the FactSet Trading API"
+        authors = listOf("FactSet")
+        license = "APACHE-2.0"
+        inceptionYear = "2023"
+        vendor = "FactSet"
+        copyright = "Copyright (c) ${LocalDate.now().year} FactSet"
+    }
 
-            if (passwordEnv == null) {
-                passwordEnv = ""
-                project.logger.error("MAVEN_PASSWORD not set")
-            }
+    signing {
+        active.set(org.jreleaser.model.Active.ALWAYS)
+        armored = true
+    }
 
-            val releasesRepoUrl = uri(releasesRepoUrlEnv)
-            val snapshotsRepoUrl = uri(snapshotsRepoUrlEnv)
-            url = if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl
+    release {
+        github { 
+            skipTag = true
+            skipRelease = true
+        }
+    }
 
-            credentials {
-                username = usernameEnv
-                password = passwordEnv
+    deploy {
+        maven {
+            mavenCentral {
+                register("release-deploy") {
+                    active.set(org.jreleaser.model.Active.RELEASE)
+                    url = "https://central.sonatype.com/api/v1/publisher"
+                    stagingRepository(releasesRepoUrl.get().asFile.path)
+                }
             }
-
-            authentication {
-                create<BasicAuthentication>("basic")
+            nexus2 {
+                register("snapshot-deploy") {
+                    active.set(org.jreleaser.model.Active.SNAPSHOT)
+                    url = "https://central.sonatype.com/repository/maven-snapshots/"
+                    snapshotUrl = "https://central.sonatype.com/repository/maven-snapshots/"
+                    applyMavenCentralRules = true
+                    snapshotSupported = true
+                    closeRepository = true
+                    releaseRepository = true
+                    stagingRepository(snapshotsRepoUrl.get().asFile.path)
+                }
             }
         }
     }
-
-    signing {
-        sign(publications["mavenJava"])
-    }
-}
+}

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Fri Apr 28 20:39:29 EDT 2023
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists