Publish libraries with correct pom files (#90)

lucianbc · web-flow · commit a61ee45cac8f · 2025-06-10T10:49:33.000+01:00
* Build validator library with correct POM

* Configure the memory footprint for publishing

* Modify build actions to build the executable jars. Publish libraries to gh artifactory
diff --git a/.github/workflows/gradle-publish-base.yml b/.github/workflows/gradle-publish-base.yml
@@ -43,12 +43,12 @@ jobs:
         uses: gradle/actions/setup-gradle@v3
         with:
           build-root-directory: play-validations
-          arguments: memory-footprint:jar -Dmemory-footprint.git_hash=${{ env.git_hash }} 
+          arguments: memory-footprint:build -Dmemory-footprint.git_hash=${{ env.git_hash }}
       - name: Build wff-validator
         uses: gradle/actions/setup-gradle@v3
         with:
-          build-root-directory: third_party/wff
-          arguments: :specification:validator:build
+          build-root-directory: play-validations
+          arguments: validator:build
       - name: Copy LICENSE files
         run: |
           mv LICENSE.txt memory-footprint_LICENSE.txt
@@ -70,82 +70,3 @@ jobs:
             **/memory-footprint.jar
             **/wff-validator.jar
             **/wff-xsd.zip
-
-  publish_packages:
-    runs-on: ubuntu-latest
-    needs: build_memory_footprint
-    env:
-      GH_TOKEN: ${{ github.token }}
-    strategy:
-      matrix:
-        jar_file: [wff-validator.jar, memory-footprint.jar]
-    steps:
-      - name: Install GitHub CLI
-        run: |
-          sudo apt-get update
-          sudo apt-get install gh
-      - name: Download asset
-        run: |
-          gh release download --repo "$GITHUB_REPOSITORY" --pattern ${{ matrix.jar_file }} 
-      - name: Get JAR version
-        id: get_version
-        run: |
-          VERSION=$(unzip -p ${{ matrix.jar_file }} META-INF/MANIFEST.MF | grep "^Version: " | cut -d' ' -f2)
-          if [[ -z "$VERSION" ]]; then
-            echo "::error file=${{ matrix.jar_file }}::Could not determine version from JAR's Manifest file"
-            exit 1
-          fi
-          echo "::set-output name=version::$VERSION"
-      - name: Determine final version
-        id: final_version
-        run: |
-          VERSION="${{ steps.get_version.outputs.version }}"
-          if ${{ inputs.release_name == 'latest' }}; then
-            VERSION="$VERSION-SNAPSHOT"
-          fi
-          echo "::set-output name=final_version::$VERSION"
-      - name: Determine artifact ID
-        id: artifact_id
-        run: |
-          FILE_NAME="${{ matrix.jar_file }}"
-          FILE_NAME_WITHOUT_EXTENSION="${FILE_NAME%.*}"
-          echo "::set-output name=artifact_id::$FILE_NAME_WITHOUT_EXTENSION"
-      - name: Check if Maven package already exists
-        id: check_exists
-        run: |
-          VERSION="${{ steps.final_version.outputs.final_version }}"
-          ARTIFACT_ID=${{ steps.artifact_id.outputs.artifact_id }}
-
-          METADATA_URL="https://maven.pkg.github.com/google/watchface/com.google.watchface/${ARTIFACT_ID}/${VERSION}/maven-metadata.xml"
-
-          if ${{ inputs.release_name == 'latest' }}; then
-            # SNAPSHOT version should always publish
-            echo "::set-output name=should_publish::true"
-          elif curl -s -f -o /dev/null -w "%{http_code}" -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" "$METADATA_URL" | grep -q "^200$"; then
-            # Don't republish existing non-SNAPSHOT versions
-            echo "Maven package with version $VERSION already exists."
-          else
-            echo "Maven package with version $VERSION does not exist."
-            echo "::set-output name=should_publish::true"
-          fi
-      - name: create settings.xml
-        if: steps.check_exists.outputs.should_publish == 'true'
-        run: |
-          mkdir -p ~/.m2
-          echo "<settings><servers><server><id>github</id><configuration><httpHeaders><property><name>Authorization</name><value>Bearer ${{ secrets.GITHUB_TOKEN }}</value></property></httpHeaders></configuration></server></servers></settings>" > ~/.m2/settings.xml
-        shell: bash
-        env:
-          GITHUB_PATH: ~/.m2/
-      - name: Publish to GitHub Packages
-        if: steps.check_exists.outputs.should_publish == 'true'
-        run: |
-          mvn deploy:deploy-file \
-            -DgroupId=com.google.watchface \
-            -DartifactId=${{ steps.artifact_id.outputs.artifact_id }} \
-            -Dversion=${{ steps.final_version.outputs.final_version }} \
-            -Dpackaging=jar \
-            -Dfile=${{ matrix.jar_file }} \
-            -Durl=https://maven.pkg.github.com/google/watchface \
-            -DrepositoryId=github -s ~/.m2/settings.xml
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/publish-libraries.yml b/.github/workflows/publish-libraries.yml
@@ -0,0 +1,55 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
+
+name: Publish Libraries
+
+on:
+  push:
+    branches: ["main"]
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  publish_libraries:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PACKAGES_URL: "https://maven.pkg.github.com/google/watchface"
+      GITHUB_PACKAGES_USER: "x-oauth-basic"
+      GITHUB_PACKAGES_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ inputs.release_git_sha }}
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: "17"
+          distribution: "corretto"
+          architecture: "x64"
+      - name: Build Memory Footprint
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          build-root-directory: play-validations
+          arguments: memory-footprint:build
+      - name: Build Validator
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          build-root-directory: play-validations
+          arguments: validator:build
+      - name: Publish Memory Footprint
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          build-root-directory: play-validations
+          arguments: memory-footprint:publishAllPublicationsToGithubPackagesRepository
+      - name: Publish WFF Validator
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          build-root-directory: play-validations
+          arguments: validator:publishAllPublicationsToGithubPackagesRepository
diff --git a/play-validations/build.gradle b/play-validations/build.gradle
@@ -51,3 +51,28 @@ allprojects { project ->
         }
     }
 }
+
+def libModules = List.of("validator", "memory-footprint")
+subprojects { project ->
+    if (project.name in libModules) {
+        afterEvaluate {
+            version = "1.6.0-SNAPSHOT"
+            group = "com.google.watchface"
+            publishing {
+                repositories {
+                    mavenLocal()
+                    if (System.getenv("GITHUB_PACKAGES_URL") != null) {
+                        maven {
+                            name = "GithubPackages"
+                            url = System.getenv("GITHUB_PACKAGES_URL")
+                            credentials {
+                                username = System.getenv("GITHUB_PACKAGES_USER")
+                                password = System.getenv("GITHUB_PACKAGES_TOKEN")
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/play-validations/memory-footprint/build.gradle b/play-validations/memory-footprint/build.gradle
@@ -16,6 +16,7 @@
 plugins {
     id 'java'
     id 'org.jetbrains.kotlin.jvm' version "2.0.21"
+    id 'maven-publish'
 }
 
 def baseVersion = "1.5.1"
@@ -50,40 +51,35 @@ compileTestKotlin {
     kotlinOptions.jvmTarget = "17"
 }
 
-configurations {
-    executableJar {
-        canBeConsumed = true
-        canBeResolved = false
-        attributes {
-            attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, objects.named(LibraryElements, 'executableJar'))
-        }
-    }
-}
-
-jar {
+tasks.register('executable-jar', Jar) {
+    dependsOn("jar")
     duplicatesStrategy(DuplicatesStrategy.EXCLUDE)
-
     exclude("META-INF/*.RSA", "META-INF/*.DSA", "META-INF/*.SF", "META-INF/maven/**")
 
     manifest {
         attributes "Main-Class": "com.google.wear.watchface.dfx.memory.ResourceMemoryEvaluator"
-        // Use `gradle :memory-footprint:jar -Dmemory-footprint.git_hash=$(git rev-parse --short HEAD)` to store
+        // Use `gradle :memory-footprint:executable-jar -Dmemory-footprint.git_hash=$(git rev-parse --short HEAD)` to store
         // the current build's hash in the manifest file.
         if (System.getProperty("memory-footprint.git_hash")) {
             attributes "Git-Hash": System.getProperty("memory-footprint.git_hash")
         }
         attributes "Version": baseVersion
     }
-
     from {
         configurations.runtimeClasspath.collect {
             it.isDirectory() ? it : zipTree(it)
         }
     }
+    from sourceSets.main.output
+    archiveVersion = ""
+    archiveBaseName = "memory-footprint"
 }
 
-artifacts {
-    executableJar(jar)
+tasks.assemble.dependsOn 'executable-jar'
+
+jar {
+    // exclude the runner class, which is not needed in the library
+    exclude 'com/google/wear/watchface/dfx/memory/ResourceMemoryEvaluator.class'
 }
 
 afterEvaluate {
@@ -114,3 +110,26 @@ test {
             "test-samples:sample-wf:zipApk"
     )
 }
+
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+            from components.java
+
+            // customize pom, removing the dependency to the validator library
+            // which is not needed when publishing the library
+            pom {
+                withXml {
+                    def dependenciesNode = asNode().dependencies[0]
+                    if (dependenciesNode) {
+                        dependenciesNode.dependency.each { dependency ->
+                            if (dependency.artifactId.text() == 'validator') {
+                                dependency.parent().remove(dependency)
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/third_party/wff/specification/validator/build.gradle b/third_party/wff/specification/validator/build.gradle
@@ -14,9 +14,7 @@
  * limitations under the License.
  */
 apply plugin: 'java-library'
-
-def baseVersion="1.5.1"
-def baseArchivesName="wff-validator"
+apply plugin: 'maven-publish'
 
 dependencies {
     implementation 'xml-apis:xml-apis:1.4.01'
@@ -30,44 +28,56 @@ tasks.register("bundleDocs", Zip) {
     from '../documents/'
     include '**/*'
     archiveBaseName = "docs"
+    archiveVersion = ""
     destinationDirectory = layout.buildDirectory.dir('libs')
 }
 
 compileJava.dependsOn(bundleDocs)
 
+// configure the library jar
 jar {
+    // include the XSDs, which are used as resources
+    from ('build/libs') {
+        include 'docs.zip'
+    }
+    // exclude the runner class, which is not needed in the library jar
+    exclude 'com/samsung/watchface/DWFValidationApplication.class'
+}
+
+tasks.register('executable-jar', Jar) {
+    dependsOn("jar")
     exclude("META-INF/maven/**")
 
     from {
         configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
     }
+    from sourceSets.main.output
 
-    base.archivesName.set(baseArchivesName)
     from ('build/libs') {
         include 'docs.zip'
     }
 
+    archiveBaseName = "wff-validator"
+    archiveVersion = ""
+
     manifest {
         attributes 'Main-Class': 'com.samsung.watchface.DWFValidationApplication'
-        attributes 'Version': baseVersion
+        attributes 'Version': version
     }
 }
 
-tasks.register('library-jar', Jar) {
-    from sourceSets.main.output
-
-    archiveBaseName.set("${baseArchivesName}-library")
-    archiveVersion.set(baseVersion)
-    from ('build/libs') {
-        include 'docs.zip'
-    }
-
-    manifest {
-        attributes 'Version': baseVersion
-    }
-}
+tasks.assemble.dependsOn 'executable-jar'
 
 java {
     sourceCompatibility = JavaVersion.VERSION_17
     targetCompatibility = JavaVersion.VERSION_17
 }
+
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+            artifactId 'wff-validator'
+            from components.java
+        }
+    }
+}
