Deploy JAR files to Maven Central for PPDTs

Author: AndrewQuijano

.github/workflows/deploy_jar.yml

@@ -0,0 +1,79 @@
+name: Publish JAR file to release
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  create_release:
+    runs-on: ubuntu-latest
+    outputs:
+      v-version: ${{ steps.version.outputs.v-version }}
+    steps:
+      # Can be major, minor, or patch, Update environment variable INCREMENT_TYPE in GitHub Actions Settings
+      - name: Set increment type from environment variable
+        run: |
+          if [ -z "${{ secrets.INCREMENT_TYPE }}" ]; then
+            echo "increment=patch" >> $GITHUB_ENV
+          else
+            echo "increment=${{ secrets.INCREMENT_TYPE }}" >> $GITHUB_ENV
+          fi
+      - name: Get next version
+        uses: reecetech/version-increment@2023.10.2
+        id: version
+        with:
+          release_branch: main
+          use_api: true
+          increment: ${{ env.increment }}
+
+  upload_release:
+    needs: [ create_release ]
+    if: github.repository == 'adwise-fiu/Level-Site-PPDT'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project sources
+        uses: actions/checkout@v4
+
+      - name: Create JAR file
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'oracle'
+          java-version: '17'
+          cache: 'gradle'
+      # Remove the leading v from the version string and set it as an environment variable
+      - run: |
+          VERSION=${{ needs.create_release.outputs.v-version }}
+          VERSION=${VERSION#v}
+          echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+      # https://central.sonatype.org/publish/publish-portal-api/
+      # https://central.sonatype.com/api-doc
+      - name: Create Bundle.zip file and use Publisher API
+        run: |
+          ./gradlew publishToMavenLocal
+          bash create_bundle.sh $VERSION
+          curl --request POST \
+            --verbose \
+            --header "Authorization: Bearer ${BEARER_TOKEN}" \
+            --form bundle=@bundle.zip \
+            --form publishingType=AUTOMATIC \
+            https://central.sonatype.com/api/v1/publisher/upload \
+            --fail --write-out "%{http_code}" --output /dev/null
+          if [ $? -ne 0 ]; then
+            echo "Error: curl did not return 201. Failing the step."
+            exit 1
+          fi
+        env:
+          SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
+          BEARER_TOKEN: ${{ secrets.BEARER_TOKEN }}
+          SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
+          VERSION: ${{ env.RELEASE_VERSION }}
+
+      - name: Release the JAR file
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ needs.create_release.outputs.v-version }}
+          files: build/libs/*.jar
+          token: ${{ secrets.GITHUB_TOKEN }}

build.gradle

@@ -1,7 +1,10 @@
 plugins {
     id 'java'
+    id 'java-library'
     id 'jacoco'
     id 'application'
+    id 'maven-publish'
+    id 'signing'
 }
 
 group 'io.github.andrewquijano'
@@ -17,17 +20,26 @@ java {
 }
 
 dependencies {
-    implementation 'junit:junit:4.13.2'
-    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.11.0-M2'
-    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.11.0-M2'
+    testImplementation 'junit:junit:4.13.2'
 
-    implementation 'io.github.andrewquijano:ciphercraft:1.0.3'
+    implementation 'io.github.andrewquijano:ciphercraft:1.0.6'
     // https://mvnrepository.com/artifact/commons-io/commons-io
     implementation 'commons-io:commons-io:2.16.1'
     // https://mvnrepository.com/artifact/nz.ac.waikato.cms.weka/weka-dev
     implementation 'nz.ac.waikato.cms.weka:weka-dev:3.9.6'
-    implementation 'org.apache.logging.log4j:log4j-core:3.0.0-beta1'
-    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    // https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core
+    implementation 'org.apache.logging.log4j:log4j-core:2.24.3'
+}
+
+// To create the JAR file with 'gradlew jar'
+tasks.named('jar') {
+    archiveFileName = "${project.name}-${project.version}.jar"
+    manifest {
+        attributes(
+                'Implementation-Title': project.name,
+                'Implementation-Version': System.getenv('VERSION') ?: project.version
+        )
+    }
 }
 
 // Commenting because it doesn't work well on TravisCI
@@ -89,3 +101,84 @@ check.dependsOn jacocoTestReport
 application {
     mainClass.set(project.findProperty("chooseRole").toString())
 }
+
+tasks.register('generateJavadoc', Javadoc) {
+    source = sourceSets.main.allJava
+    classpath = sourceSets.main.compileClasspath
+    options.encoding = 'UTF-8'
+    options.memberLevel = JavadocMemberLevel.PUBLIC
+    options.addStringOption('Xdoclint:none', '-quiet')
+    options.docTitle = 'Level-Site Privacy-Preserving Decision Tree'
+}
+
+// This is for publishing the library to Maven Central
+publishing {
+    publications {
+        register("mavenJava", MavenPublication) {
+            from components.java
+
+            pom {
+                name.set('level-site-ppdt')
+                description.set('This JAR file is used for implementing the Level-Site Privacy-Preserving Decision Trees (PPDT). ' +
+                        'See the paper "Enhanced Outsourced and Secure Inference for Tall Sparse Decision Trees" which describes the implementation and ' +
+                        'performance gains this approach has in avoiding the conversion to a complete binary tree as in the Joye and Salehi paper.')
+                url.set('https://github.com/adwise-fiu/Level-Site-PPDT')
+
+                licenses {
+                    license {
+                        name.set('MIT License')
+                        url.set('https://opensource.org/licenses/MIT')
+                    }
+                }
+
+                developers {
+                    developer {
+                        id.set('AndrewQuijano')
+                        name.set('Andrew Quijano')
+                        email.set('andrew.quijano@nyu.edu')
+                    }
+                }
+
+                scm {
+                    connection.set('scm:git:git://github.com/adwise-fiu/Level-Site-PPDT.git')
+                    developerConnection.set('scm:git:ssh://github.com:adwise-fiu/Level-Site-PPDT.git')
+                    url.set('https://github.com/adwise-fiu/Level-Site-PPDT')
+                }
+            }
+        }
+    }
+}
+
+// Update this file, ~/.gnupg/dirmngr.conf
+// and add this line to the file 'keyserver hkps://keyserver.ubuntu.com'
+// then run 'gpg --send-keys YOUR_KEY_ID'
+signing {
+    // Point to the key file on your machine, used for local testing
+    def signingKeyFile = findProperty("signingKeyFile") ?: System.getenv("SIGNING_KEY_FILE")
+    // gpg --armor --export-secret-keys YOUR_KEY_ID, export the key into a secret
+    def signingKey = findProperty("signingKey") ?: System.getenv("SIGNING_KEY") ?: ""
+    // If no property or environment variable is found, it will be empty password
+    def signingPassword = findProperty("signingPassword") ?: System.getenv("SIGNING_PASSWORD") ?: ""
+
+    if (signingKeyFile) {
+        println("Reading signing key from file: $signingKeyFile")
+        def signingKey_content = new File(signingKeyFile.toString()).text
+        useInMemoryPgpKeys(signingKey_content.toString(), signingPassword.toString())
+        publishing.publications.named("mavenJava").configure { publication ->
+            signing.sign(publication)
+        }
+    }
+    else {
+        println("No signing key file found, will attempt to use in-memory key")
+        if (signingKey) {
+            println("Using in-memory signing key")
+            useInMemoryPgpKeys(signingKey.toString(), signingPassword?.toString())
+            publishing.publications.named("mavenJava").configure { publication ->
+                signing.sign(publication)
+            }
+        }
+        else {
+            println("No signing key found. Skipping signing.")
+        }
+    }
+}

create_bundle.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+# Check if a version argument is provided
+if [ -z "$1" ]; then
+  echo "Usage: $0 <version>"
+  exit 1
+fi
+
+# First, you do need to run './gradlew publish' to generate the artifacts.
+# I can't publish via API, but I can create a bundle for manual upload.
+
+VERSION=$1
+GROUP_ID=io/github/andrewquijano
+# This needs to match name in settings.gradle
+PROJECT=level-site-ppdt
+
+# Use this script as a stop gap for manual uploading
+mkdir -p $GROUP_ID/$PROJECT/$VERSION
+cp build/libs/* $GROUP_ID/$PROJECT/$VERSION/
+cp build/publications/mavenJava/pom-default.xml $GROUP_ID/$PROJECT/$VERSION/$PROJECT-$VERSION.pom
+cp build/publications/mavenJava/pom-default.xml.asc $GROUP_ID/$PROJECT/$VERSION/$PROJECT-$VERSION.pom.asc
+
+# Loop through all files in the specified directory
+for file in $GROUP_ID/$PROJECT/$VERSION/*; do
+  # Print the file being checked
+  echo "Processing file: $file"
+
+  # Skip files ending with .asc
+  if [[ -f "$file" && ! "$file" =~ \.asc$ ]]; then
+    echo "Generating hashes for: $file"
+
+    # Generate SHA1 checksum
+    sha1sum "$file" | awk '{print $1}' > "${file}.sha1"
+
+    # Generate MD5 checksum
+    md5sum "$file" | awk '{print $1}' > "${file}.md5"
+  else
+    echo "Skipping file: $file"
+  fi
+done
+
+zip -r bundle.zip io/

settings.gradle

@@ -1,2 +1,2 @@
-rootProject.name = 'ppdt'
+rootProject.name = 'level-site-ppdt'