Merge pull request #7 from Esri/jonas/add-jreleaser

ci: publish to maven

Author: JonasVautherin

.github/workflows/main.yml

@@ -12,6 +12,7 @@ on:
 
 jobs:
   build:
+    if: github.event_name != 'release'
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
@@ -22,6 +23,30 @@ jobs:
       - name: Test
         run: ./gradlew test
 
+  deploy:
+    if: github.event_name == 'release' && github.event.action == 'created'
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Validate version
+        id: version
+        run: |
+          set -o pipefail
+          tag_name="${{ github.ref_name }}"
+          python ./tools/version_validator.py "$tag_name"
+          echo "tag_name=$tag_name" >> $GITHUB_OUTPUT
+      - name: Build
+        run: ./gradlew -PVERSION=${{ steps.version.outputs.tag_name }} build
+      - name: Test
+        run: ./gradlew -PVERSION=${{ steps.version.outputs.tag_name }} test
+      - name: Publish (Maven)
+        run: |
+            echo -n "${{ secrets.MAVEN_SIGNING_KEY }}" | base64 --decode | gpg --import
+            ./gradlew -PVERSION=${{ steps.version.outputs.tag_name }} -PcentralUsername=${{ secrets.CENTRAL_USERNAME }} -PcentralPassword=${{ secrets.CENTRAL_PASSWORD }} publish
+            ./gradlew -PVERSION=${{ steps.version.outputs.tag_name }} -PcentralUsername=${{ secrets.CENTRAL_USERNAME }} -PcentralPassword=${{ secrets.CENTRAL_PASSWORD }} jreleaserDeploy
+
   xmllint:
     runs-on: ubuntu-24.04
     steps:

build.gradle.kts

@@ -1,6 +1,23 @@
+import java.util.Properties
+import java.io.FileInputStream
+import java.io.IOException
+
 plugins {
   alias(libs.plugins.android.library)
   alias(libs.plugins.jetbrains.kotlin.android)
+  alias(libs.plugins.jreleaser)
+  `maven-publish`
+}
+
+// Load file "keystore.properties" where we keep our keys
+val keystorePropertiesFile = rootProject.file("keystore.properties")
+val keystoreProperties = Properties()
+
+try {
+    keystoreProperties.load(FileInputStream(keystorePropertiesFile))
+} catch (ignored: IOException) {
+    if (project.hasProperty("centralUsername")) keystoreProperties["centralUsername"] = property("centralUsername")
+    if (project.hasProperty("centralPassword")) keystoreProperties["centralPassword"] = property("centralPassword")
 }
 
 android {
@@ -9,8 +26,12 @@ android {
 
   defaultConfig {
     minSdk = 24
-    group = "com.esri"
-    version = "0.0.1"
+    group = "com.esri.logger"
+
+    // The version must be of the form "X.Y.Z[-b][-SNAPSHOT]"
+    version =
+      if (project.hasProperty("VERSION")) project.property("VERSION").toString()
+      else "0.0.1-SNAPSHOT"
 
     testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
   }
@@ -26,6 +47,10 @@ android {
   }
   kotlinOptions { jvmTarget = "17" }
   testOptions { unitTests { isIncludeAndroidResources = true } }
+
+  publishing {
+    singleVariant("release") {}
+  }
 }
 
 tasks.withType<Test> {
@@ -52,3 +77,99 @@ dependencies {
   androidTestImplementation(libs.androidx.junit)
   androidTestImplementation(libs.androidx.espresso.core)
 }
+
+if (keystoreProperties.containsKey("centralUsername") && keystoreProperties.containsKey("centralPassword")) {
+    afterEvaluate {
+        publishing {
+            publications {
+                create<MavenPublication>("release") {
+                    from(components["release"])
+
+                    pom {
+                        name = "Khronicle"
+                        packaging = "aar"
+                        description = "An SLF4J backend for Android."
+                        url = "https://github.com/esri/khronicle"
+
+                        scm {
+                        connection = "scm:git:https://github.com/esri/khronicle"
+                        developerConnection = "scm:git:https://github.com/esri/khronicle"
+                        url = "https://github.com/esri/khronicle"
+                        }
+
+                        licenses {
+                            license {
+                                name = "Apache License 2.0"
+                                url = "https://spdx.org/licenses/Apache-2.0.html"
+                            }
+                        }
+
+                        developers {
+                            developer {
+                                id = "award"
+                                name = "Adam Ward"
+                                email = "[email protected]"
+                            }
+                            developer {
+                                id = "jonasvautherin"
+                                name = "Jonas Vautherin"
+                                email = "[email protected]"
+                            }
+                        }
+                    }
+                }
+            }
+            repositories {
+                maven {
+                   url = uri(layout.buildDirectory.dir("target/staging-deploy"))
+                }
+            }
+        }
+    }
+
+    jreleaser {
+        signing {
+            setActive("ALWAYS")
+            armored.set(true)
+            setMode("COMMAND")
+
+            command {
+                keyName.set("C8B1511EF991537875A649517D5F7A7C9542C299")
+            }
+        }
+        deploy {
+            release {
+                github {
+                    skipRelease = true
+                    skipTag = true
+                }
+            }
+            maven {
+                mavenCentral {
+                    create("sonatype") {
+                        verifyPom = false
+                        setActive("RELEASE")
+                        username = keystoreProperties["centralUsername"] as String
+                        password = keystoreProperties["centralPassword"] as String
+                        url = "https://central.sonatype.com/api/v1/publisher"
+                        stagingRepository("build/target/staging-deploy")
+                    }
+                }
+                nexus2 {
+                    create("snapshot-deploy") {
+                        verifyPom = false
+                        setActive("SNAPSHOT")
+                        snapshotUrl.set("https://central.sonatype.com/repository/maven-snapshots")
+                        url = "https://central.sonatype.com/repository/maven-snapshots"
+                        applyMavenCentralRules = true
+                        snapshotSupported = true
+                        username = keystoreProperties["centralUsername"] as String
+                        password = keystoreProperties["centralPassword"] as String
+                        stagingRepository("build/target/staging-deploy")
+                    }
+                }
+            }
+        }
+    }
+}
+

gradle/libs.versions.toml

@@ -5,6 +5,7 @@ coreKtx = "1.16.0"
 espressoCore = "3.6.1"
 junit = "4.13.2"
 junitVersion = "1.2.1"
+jreleaser-plugin = "1.19.0"
 kotlin = "2.1.20"
 kotlinReflect = "2.1.0"
 material = "1.12.0"
@@ -28,4 +29,5 @@ slf4j-api = { group = "org.slf4j", name = "slf4j-api", version.ref = "slf4jApi"}
 [plugins]
 android-library = { id = "com.android.library", version.ref = "agp" }
 jetbrains-kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
+jreleaser = { id = "org.jreleaser", version.ref = "jreleaser-plugin" }
 

settings.gradle.kts

@@ -14,4 +14,4 @@ dependencyResolutionManagement {
   }
 }
 
-rootProject.name = "logger-android"
+rootProject.name = "khronicle"

tools/version_validator.py

@@ -0,0 +1,159 @@
+#!/usr/bin/env python3
+"""
+Version Number Validator
+
+This script validates version numbers and extracts major.minor.patch format.
+
+Version format rules:
+- Can start with 'v' (optional): v2.3.1 or 2.3.1
+- Must have major.minor.patch: 1.2.3 (minimum required)
+- May have build number: 1.2.3-1 or 1.2.3-2
+- May end with -SNAPSHOT: 3.4.5-1-SNAPSHOT or 3.4.5-SNAPSHOT
+
+Usage:
+    python version_validator.py <version_string>
+    python version_validator.py --extract <version_string>
+"""
+
+import re
+import sys
+import argparse
+
+def extract_major_minor_patch(version_string):
+    """
+    Extract major.minor.patch from a valid version string in vX.Y.Z format.
+
+    Args:
+        version_string (str): The version string to extract from
+
+    Returns:
+        str: The extracted version in vX.Y.Z format, or None if invalid
+    """
+    # Define the regex pattern for valid version strings
+    pattern = r'^v?(\d+)\.(\d+)\.(\d+)(?:-(\d+))?(?:-SNAPSHOT)?$'
+    match = re.match(pattern, version_string)
+
+    if match:
+        major, minor, patch = match.groups()[:3]
+        return f"v{major}.{minor}.{patch}"
+
+    return None
+
+def validate_version(version_string):
+    """
+    Validate a version string according to the specified rules.
+
+    Args:
+        version_string (str): The version string to validate
+
+    Returns:
+        bool: True if valid, False otherwise
+    """
+    return extract_major_minor_patch(version_string) is not None
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Validate version number and extract major.minor.patch format",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Examples:
+    python version_validator.py v2.3.1                     # Validate version
+    python version_validator.py 1.2.3-1                    # Validate version with build
+    python version_validator.py --extract v2.3.1-SNAPSHOT  # Extract v2.3.1
+    python version_validator.py -e 3.4.5-2-SNAPSHOT        # Extract v3.4.5
+
+Valid version formats:
+    v1.2.3, 1.2.3, v1.2.3-1, 1.2.3-1, v1.2.3-SNAPSHOT, 1.2.3-1-SNAPSHOT
+        """
+    )
+
+    parser.add_argument(
+        'version', 
+        help='Version string to validate/extract'
+    )
+    parser.add_argument(
+        '-e', '--extract', 
+        action='store_true',
+        help='Extract major.minor.patch in vX.Y.Z format'
+    )
+
+    args = parser.parse_args()
+
+    if args.extract:
+        # Extract mode
+        result = extract_major_minor_patch(args.version)
+        if result:
+            print(result)
+            sys.exit(0)
+        else:
+            print(f"Error: '{args.version}' is not a valid version string", file=sys.stderr)
+            sys.exit(1)
+    else:
+        # Validation mode
+        if validate_version(args.version):
+            print(f"'{args.version}' is a valid version string")
+            sys.exit(0)
+        else:
+            print(f"Error: '{args.version}' is not a valid version string", file=sys.stderr)
+            sys.exit(1)
+
+
+if __name__ == "__main__":
+    # If no arguments provided, run some test cases
+    if len(sys.argv) == 1:
+        print("Running test cases...")
+
+        test_cases = [
+            # Valid cases
+            ("v2.3.1", True),
+            ("2.3.1", True),
+            ("1.2.3-1", True),
+            ("v1.2.3-1", True),
+            ("3.4.5-SNAPSHOT", True),
+            ("v3.4.5-SNAPSHOT", True),
+            ("1.2.3-1-SNAPSHOT", True),
+            ("v1.2.3-1-SNAPSHOT", True),
+            ("10.20.30", True),
+            ("v0.0.1", True),
+
+            # Invalid cases
+            ("1.2", False),
+            ("v1.2", False),
+            ("1.2.3.4", False),
+            ("v1.2.3.4", False),
+            ("1.2.3-", False),
+            ("1.2.3-SNAPSHOT-1", False),
+            ("1.2.3-a", False),
+            ("v1.2.3-a", False),
+            ("av1.2.3", False),
+            ("a1.2.3", False),
+            (" v1.2.3", False),
+            ("V1.2.3-a", False),
+            ("1.2.x", False),
+            ("", False),
+            ("v", False),
+            ("1.2.3-1-SNAPSHOT-extra", False),
+        ]
+
+        print("\nValidation Tests:")
+        for version, expected in test_cases:
+            result = validate_version(version)
+            status = "✓" if result == expected else "✗"
+            print(f"{status} {version:<25} -> {result} (expected {expected})")
+
+        print("\nExtraction Tests:")
+        extraction_tests = [
+            ("v2.3.1", "v2.3.1"),
+            ("2.3.1", "v2.3.1"),
+            ("1.2.3-1", "v1.2.3"),
+            ("v1.2.3-1-SNAPSHOT", "v1.2.3"),
+            ("3.4.5-SNAPSHOT", "v3.4.5"),
+            ("invalid", None),
+        ]
+
+        for version, expected in extraction_tests:
+            result = extract_major_minor_patch(version)
+            status = "✓" if result == expected else "✗"
+            print(f"{status} {version:<25} -> {result} (expected {expected})")
+    else:
+        main()