ci: build and publish javax flavour

The 'release' github action has a new job to build the javax flavour of
this project. This job has three main steps:
 - Replace all the jakarta imports and dependencies with the javax ones
 - Downgrade springframework dependency to the version 5.*
 - Using jdk 11 to build the project and publish it

The cold migration from jakarta to javax is done via a new bash script
`.github/replaceJakartaWithJavax.sh` that uses mainly the sed command to
perform the replacement operations.

In gradle.properties the SOURCE_COMPATIBILITY and the TARGET_COMPATIBILITY
constants are downgraded to 11 in order to allow the users to use the
latest version of this library even in projects where the jdk11 is mandatory.

Updated the README with a brief explanation of the difference between
the two flavours of this project.

Author: federicorispo

.github/add-module-suffix.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-MODULE_SUFFIX="${GITHUB_REF##*/}"
+MODULE_SUFFIX="${1}"
 
 addSuffix() {
   local result

.github/release.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -ev
 
-BRANCH="${GITHUB_REF##*/}"
+FLAVOUR="${1}"
 
 removeSnapshots() {
   sed -i 's/-SNAPSHOT//' gradle.properties
@@ -10,8 +10,8 @@ removeSnapshots() {
 echo "Publishing release to Maven Central"
 removeSnapshots
 
-if [[ "${BRANCH}" != "master" ]]; then
-  .github/add-module-suffix.sh
+if [ -n "${FLAVOUR}" ]; then
+  .github/add-module-suffix.sh $FLAVOUR
 fi
 
 ./gradlew clean build publishToSonatype closeAndReleaseSonatypeStagingRepository

.github/replaceJakartaWithJavax.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Set jdk11 as source and target
+sed -i 's/SOURCE_COMPATIBILITY=.*/SOURCE_COMPATIBILITY=11/' gradle.properties
+sed -i 's/TARGET_COMPATIBILITY=.*/TARGET_COMPATIBILITY=11/' gradle.properties
+
+# Replace jakarta imports and dependencies with javax
+grep -rl 'import jakarta' ./graphql-java-servlet | xargs sed -i 's/import jakarta/import javax/g'
+sed -i 's/.*jakarta.websocket:jakarta.websocket-client-api.*//' graphql-java-servlet/build.gradle
+sed -i \
+  's/jakarta.servlet:jakarta.servlet-api.*/javax.servlet:javax.servlet-api:$LIB_JAVAX_SERVLET"/' \
+  graphql-java-servlet/build.gradle
+sed -i \
+  's/jakarta.websocket.*/javax.websocket:javax.websocket-api:$LIB_JAVAX_WEBSOCKET"/' \
+  graphql-java-servlet/build.gradle
+
+# Final check if there are something else to replace
+grep -rl 'jakarta' ./graphql-java-servlet | xargs sed -i 's/jakarta/javax/g'
+
+# Set the version 5 for spring framework
+sed -i \
+  's/org.springframework:spring-test.*/org.springframework:spring-test:$LIB_SPRINGFRAMEWORK_5"/' \
+  graphql-java-servlet/build.gradle
+sed -i \
+  's/org.springframework:spring-web.*/org.springframework:spring-web:$LIB_SPRINGFRAMEWORK_5"/' \
+  graphql-java-servlet/build.gradle
+
+echo "Replaced jakarta occurrences with javax"

.github/tag-release.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -ev
 
-BRANCH="${GITHUB_REF##*/}"
+FLAVOUR="${1}"
 
 getVersion() {
   ./gradlew properties -q | grep -E "^version" | awk '{print $2}' | tr -d '[:space:]'
@@ -13,10 +13,10 @@ removeSnapshots() {
 
 commitRelease() {
   local APP_VERSION
-  if "${BRANCH}" == "master"; then
+  if [ -z "${FLAVOUR}" ]; then
     APP_VERSION=$(getVersion)
   else
-    APP_VERSION=$(getVersion)-"${BRANCH}"
+    APP_VERSION=$(getVersion)-"${FLAVOUR}"
   fi
   git commit -a -m "Update version for release"
   git tag -a "v${APP_VERSION}" -m "Tag release version"

.github/workflows/release.yml

@@ -37,8 +37,8 @@ jobs:
       - name: Gradle Check
         run: ./gradlew --info check
 
-  build:
-    name: Publish release
+  build-jakarta:
+    name: Publish release jakarta
     needs: test
     runs-on: ubuntu-latest
     steps:
@@ -74,9 +74,48 @@ jobs:
           OSS_USER_TOKEN_PASS: ${{ secrets.OSS_USER_TOKEN_PASS }}
         run: .github/release.sh
 
+  build-javax:
+    name: Publish release javax
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'zulu'
+          java-version: 11
+
+      - name: Cache Gradle
+        uses: actions/cache@v3
+        env:
+          java-version: 11
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-${{ env.java-version }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.java-version }}-gradle-
+      - name: Prepare environment
+        env:
+          GPG_KEY_CONTENTS: ${{ secrets.GPG_KEY_CONTENTS }}
+          SIGNING_SECRET_KEY_RING_FILE: ${{ secrets.GPG_SIGNING_SECRET_KEY_RING_FILE }}
+        run: sudo bash -c "echo '$GPG_KEY_CONTENTS' | base64 -d > '$SIGNING_SECRET_KEY_RING_FILE'"
+      - name: Replace jakarta with javax
+        run: .github/replaceJakartaWithJavax.sh
+      - name: Publish release
+        env:
+          SIGNING_KEY_ID: ${{ secrets.GPG_SIGNING_KEY_ID }}
+          SIGNING_PASSWORD: ${{ secrets.GPG_SIGNING_PASSWORD }}
+          SIGNING_SECRET_KEY_RING_FILE: ${{ secrets.GPG_SIGNING_SECRET_KEY_RING_FILE }}
+          OSS_USER_TOKEN_KEY: ${{ secrets.OSS_USER_TOKEN_KEY }}
+          OSS_USER_TOKEN_PASS: ${{ secrets.OSS_USER_TOKEN_PASS }}
+        run: .github/release.sh javax
   tag:
     name: Tag release
-    needs: build
+    needs: [ build-jakarta, build-javax ]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -98,4 +137,4 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-${{ env.java-version }}-gradle-
       - name: Tag release
-        run: .github/tag-release.sh
+        run: .github/tag-release.sh

README.md

@@ -19,7 +19,20 @@ This project wraps the Java implementation of GraphQL provided by [GraphQL Java]
 See [GraphQL Java documentation](https://www.graphql-java.com/documentation/latest/) for more in depth details
 regarding GraphQL Java itself. 
 
-We try to stay up to date with GraphQL Java as much as possible. See [gradle.properties](gradle.properties) to see currently supported versions.
+We try to stay up to date with GraphQL Java as much as possible maintaining the retro-compatibility
+with javax and Springframework 5.
+
+On each release we publish two flavours of this project:
+ - the main one is using `jakarta` and Springframework `6.*` 
+ - the legacy one is using `javax` and Springframework `5.*`
+
+On maven central you can distinguish them from the version because the `javax` flavor has the 
+suffix `-javax`.
+
+Both of them also supports legacy projects that can compile with older JDK versions: the oldest
+supported one is the `11`.
+
+See [gradle.properties](gradle.properties) to see currently supported versions.
 
 ## Installation and getting started
 

build.gradle

@@ -76,6 +76,11 @@ subprojects {
         targetCompatibility = TARGET_COMPATIBILITY
     }
 
+    compileTestJava {
+        sourceCompatibility = 17
+        targetCompatibility = 17
+    }
+
     compileJava.dependsOn(processResources)
 
     test {

gradle.properties

@@ -11,5 +11,9 @@ LIB_GRAPHQL_JAVA_VER=20.2
 LIB_JACKSON_VER=2.15.0
 LIB_SLF4J_VER=2.0.7
 LIB_LOMBOK_VER=1.18.26
-SOURCE_COMPATIBILITY=17
-TARGET_COMPATIBILITY=17
+# These constants are necessary to the automatic release of javax flavour
+LIB_JAVAX_SERVLET=4.0.1
+LIB_JAVAX_WEBSOCKET=1.1
+LIB_SPRINGFRAMEWORK_5=5.3.25
+SOURCE_COMPATIBILITY=11
+TARGET_COMPATIBILITY=11

graphql-java-servlet/build.gradle

@@ -16,9 +16,9 @@ dependencies {
     api(project(':graphql-java-kickstart'))
 
     // Servlet
-    compileOnly 'jakarta.servlet:jakarta.servlet-api:6.0.0'
-    compileOnly 'jakarta.websocket:jakarta.websocket-api:2.1.0'
-    compileOnly 'jakarta.websocket:jakarta.websocket-client-api:2.1.0'
+    compileOnly "jakarta.servlet:jakarta.servlet-api:6.0.0"
+    compileOnly "jakarta.websocket:jakarta.websocket-api:2.1.0"
+    compileOnly "jakarta.websocket:jakarta.websocket-client-api:2.1.0"
     implementation "org.slf4j:slf4j-api:$LIB_SLF4J_VER"
 
     // OSGi
@@ -37,10 +37,10 @@ dependencies {
     testRuntimeOnly "cglib:cglib-nodep:3.3.0"
     testRuntimeOnly "org.objenesis:objenesis:3.3"
     testImplementation "org.slf4j:slf4j-simple:$LIB_SLF4J_VER"
-    testImplementation 'org.springframework:spring-test:6.0.9'
-    testRuntimeOnly 'org.springframework:spring-web:6.0.9'
+    testImplementation "org.springframework:spring-test:6.0.9"
+    testRuntimeOnly "org.springframework:spring-web:6.0.9"
     testImplementation 'com.google.guava:guava:31.1-jre'
-    testImplementation 'jakarta.servlet:jakarta.servlet-api:6.0.0'
-    testImplementation 'jakarta.websocket:jakarta.websocket-api:2.1.0'
-    testImplementation 'jakarta.websocket:jakarta.websocket-client-api:2.1.0'
+    testImplementation "jakarta.servlet:jakarta.servlet-api:6.0.0"
+    testImplementation "jakarta.websocket:jakarta.websocket-api:2.1.0"
+    testImplementation "jakarta.websocket:jakarta.websocket-client-api:2.1.0"
 }