Improve build scripts and workflows

Author: shai-almog

.github/workflows/pr.yml

@@ -1,12 +1,18 @@
 name: PR CI
 
-on:   
+on:
   pull_request:
     branches:
       - master
+    paths-ignore:
+      - 'scripts/**'
+      - '**/*.md'
   push:
     branches:
       - master
+    paths-ignore:
+      - 'scripts/**'
+      - '**/*.md'
 
 jobs:
   build-linux-jdk8-fx:

.github/workflows/scripts-android.yml

@@ -2,19 +2,25 @@
 name: Test Android build scripts
 
 'on':
-  push:
+  pull_request:
     paths:
       - 'scripts/**'
-  pull_request:
+      - 'BUILDING.md'
+  push:
+    branches:
+      - master
     paths:
       - 'scripts/**'
+      - 'BUILDING.md'
 
 jobs:
   build-android:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Setup workspace
+        run: ./scripts/setup-workspace.sh -q -DskipTests
       - name: Build Android port
         run: |
-          ./scripts/setup-workspace.sh -q -DskipTests
+          source tools/env.sh
           ./scripts/build-android-port.sh -q -DskipTests

.github/workflows/scripts-ios.yml

@@ -2,19 +2,25 @@
 name: Test iOS build scripts
 
 'on':
-  push:
+  pull_request:
     paths:
       - 'scripts/**'
-  pull_request:
+      - 'BUILDING.md'
+  push:
+    branches:
+      - master
     paths:
       - 'scripts/**'
+      - 'BUILDING.md'
 
 jobs:
   build-ios:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Setup workspace
+        run: ./scripts/setup-workspace.sh -q -DskipTests
       - name: Build iOS port
         run: |
-          ./scripts/setup-workspace.sh -q -DskipTests
+          source tools/env.sh
           ./scripts/build-ios-port.sh -q -DskipTests

BUILDING.md

@@ -1,12 +1,13 @@
 # Building Codename One
 
-This guide describes how to build Codename One and its Android and iOS ports locally using Maven. It includes reproducible steps for setting up the workspace and compiling each port.
+This document provides reproducible instructions for building Codename One and its Android and iOS ports with Maven. It is written so that both developers and automated tools can follow it step by step.
 
 ## Prerequisites
 
-- **JDK 11** for building the main project and the iOS port.
+- **JDK 11** (Codename One also builds with JDK 8, but these instructions use JDK 11).
 - **JDK 17** for building the Android port.
 - **Apache Maven 3.6+**.
+- macOS with Xcode (only for building the iOS port).
 
 The `setup-workspace.sh` script downloads these dependencies automatically when they are not already installed.
 
@@ -38,13 +39,14 @@ Clone the repository and run the setup script to install Maven, download JDK 11
 git clone https://github.com/codenameone/CodenameOne
 cd CodenameOne
 ./scripts/setup-workspace.sh -DskipTests
+source tools/env.sh
 ```
 
-The script runs `mvn install` in `maven/`, installs `cn1-maven-archetypes`, and ensures `~/.codenameone/CodeNameOneBuildClient.jar` is installed by invoking the `cn1:install-codenameone` Maven goal. If that goal fails, the script copies the jar from `maven/CodeNameOneBuildClient.jar`.
+The script runs `mvn install` in `maven/`, installs `cn1-maven-archetypes`, and ensures `~/.codenameone/CodeNameOneBuildClient.jar` is installed by invoking the `cn1:install-codenameone` Maven goal. If that goal fails, the script copies the jar from `maven/CodeNameOneBuildClient.jar`. After the script finishes, `tools/env.sh` contains environment variables for the provisioned JDKs and Maven.
 
 ## Building the Android port
 
-Run the Android build script. It requires `JAVA_HOME` pointing to JDK 11 and `JAVA_HOME_17` pointing to JDK 17. If these variables are unset, the script will look for the JDKs under `tools/` as provisioned by `setup-workspace.sh`:
+Run the Android build script. It sources the environment from `tools/env.sh`, ensuring `JAVA_HOME` points to JDK 11 and `JAVA_HOME_17` points to JDK 17. If the JDKs are missing, the script will run `setup-workspace.sh` to download them:
 
 ```bash
 ./scripts/build-android-port.sh -DskipTests
@@ -54,7 +56,7 @@ The resulting artifacts are placed in `maven/android/target`.
 
 ## Building the iOS port
 
-The iOS port can only be built on macOS with Xcode installed. The build script expects `JAVA_HOME` to point to JDK 11 and will search `tools/` if it is not set:
+The iOS port can only be built on macOS with Xcode installed. The build script sources `tools/env.sh` and ensures `JAVA_HOME` points to JDK 11, running `setup-workspace.sh` if necessary:
 
 ```bash
 ./scripts/build-ios-port.sh -DskipTests
@@ -66,7 +68,7 @@ The build output is in `maven/ios/target`.
 
 The `scripts` directory contains helper scripts:
 
-- `setup-workspace.sh` – installs Maven, downloads JDK 11 and JDK 17, builds the core modules, installs Maven archetypes, and provisions the Codename One build client.
+- `setup-workspace.sh` – installs Maven, downloads JDK 11 and JDK 17, builds the core modules, installs Maven archetypes, provisions the Codename One build client, and writes `tools/env.sh`.
 - `build-android-port.sh` – builds the Android port using JDK 11 for Maven and JDK 17 for compilation.
 - `build-ios-port.sh` – builds the iOS port on macOS with JDK 11.
 

scripts/build-android-port.sh

@@ -5,25 +5,33 @@ set -e
 DIR="$(cd "$(dirname "$0")" && pwd)/.."
 cd "$DIR"
 
-# Locate JDK 11
+if [ -f "$DIR/tools/env.sh" ]; then
+  source "$DIR/tools/env.sh"
+fi
+
 if [ -z "$JAVA_HOME" ] || ! "$JAVA_HOME/bin/java" -version 2>&1 | head -n1 | grep -q "11"; then
-  JAVA_HOME=$(ls -d "$DIR"/tools/jdk-11* 2>/dev/null | head -n1)
+  echo "Provisioning workspace..."
+  ./scripts/setup-workspace.sh -q -DskipTests
+  source "$DIR/tools/env.sh"
 fi
+
 if [ -z "$JAVA_HOME" ] || ! "$JAVA_HOME/bin/java" -version 2>&1 | head -n1 | grep -q "11"; then
-  echo "JAVA_HOME must point to JDK 11." >&2
+  echo "Failed to set up JDK 11." >&2
   exit 1
 fi
 
-# Locate JDK 17
 if [ -z "$JAVA_HOME_17" ] || ! "$JAVA_HOME_17/bin/java" -version 2>&1 | head -n1 | grep -q "17"; then
-  JAVA_HOME_17=$(ls -d "$DIR"/tools/jdk-17* 2>/dev/null | head -n1)
+  echo "Provisioning JDK 17..."
+  ./scripts/setup-workspace.sh -q -DskipTests
+  source "$DIR/tools/env.sh"
 fi
+
 if [ -z "$JAVA_HOME_17" ] || ! "$JAVA_HOME_17/bin/java" -version 2>&1 | head -n1 | grep -q "17"; then
-  echo "JAVA_HOME_17 must point to JDK 17." >&2
+  echo "Failed to set up JDK 17." >&2
   exit 1
 fi
 
-export PATH="$JAVA_HOME/bin:$PATH"
+export PATH="$JAVA_HOME/bin:$MAVEN_HOME/bin:$PATH"
 
 BUILD_CLIENT="$HOME/.codenameone/CodeNameOneBuildClient.jar"
 if [ ! -f "$BUILD_CLIENT" ]; then

scripts/build-ios-port.sh

@@ -15,16 +15,22 @@ fi
 DIR="$(cd "$(dirname "$0")" && pwd)/.."
 cd "$DIR"
 
-# Locate JDK 11
-if [ -z "$JAVA_HOME" ]; then
-  JAVA_HOME=$(ls -d "$DIR"/tools/jdk-11* 2>/dev/null | head -n1)
+if [ -f "$DIR/tools/env.sh" ]; then
+  source "$DIR/tools/env.sh"
 fi
+
+if [ -z "$JAVA_HOME" ] || ! "$JAVA_HOME/bin/java" -version 2>&1 | head -n1 | grep -q "11"; then
+  echo "Provisioning workspace..."
+  ./scripts/setup-workspace.sh -q -DskipTests
+  source "$DIR/tools/env.sh"
+fi
+
 if [ -z "$JAVA_HOME" ] || ! "$JAVA_HOME/bin/java" -version 2>&1 | head -n1 | grep -q "11"; then
-  echo "JAVA_HOME must point to JDK 11." >&2
+  echo "Failed to set up JDK 11." >&2
   exit 1
 fi
 
-export PATH="$JAVA_HOME/bin:$PATH"
+export PATH="$JAVA_HOME/bin:$MAVEN_HOME/bin:$PATH"
 
 BUILD_CLIENT="$HOME/.codenameone/CodeNameOneBuildClient.jar"
 if [ ! -f "$BUILD_CLIENT" ]; then

scripts/setup-workspace.sh

@@ -26,16 +26,17 @@ ensure_jdk() {
 }
 
 ensure_maven() {
-  if ! command -v mvn >/dev/null; then
-    local version="3.9.6"
+  local version="3.9.6"
+  MAVEN_HOME="$TOOLS_DIR/apache-maven-$version"
+  if [ ! -d "$MAVEN_HOME" ]; then
     local archive="$TOOLS_DIR/apache-maven-$version-bin.tar.gz"
     echo "Downloading Maven $version..."
     curl -L -o "$archive" "https://archive.apache.org/dist/maven/maven-3/$version/binaries/apache-maven-$version-bin.tar.gz"
     tar -xzf "$archive" -C "$TOOLS_DIR"
     rm "$archive"
-    MAVEN_HOME="$TOOLS_DIR/apache-maven-$version"
-    export PATH="$MAVEN_HOME/bin:$PATH"
   fi
+  export MAVEN_HOME
+  export PATH="$MAVEN_HOME/bin:$PATH"
 }
 
 detect_platform() {
@@ -54,17 +55,21 @@ detect_platform() {
 
 detect_platform
 
-JDK11_URL="https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.28%2B6/"\
-"OpenJDK11U-jdk_${arch}_${platform}_hotspot_11.0.28_6.tar.gz"
-JDK17_URL="https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.16%2B8/"\
-"OpenJDK17U-jdk_${arch}_${platform}_hotspot_17.0.16_8.tar.gz"
+JDK11_URL="https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.28%2B6/OpenJDK11U-jdk_${arch}_${platform}_hotspot_11.0.28_6.tar.gz"
+JDK17_URL="https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.16%2B8/OpenJDK17U-jdk_${arch}_${platform}_hotspot_17.0.16_8.tar.gz"
 
 ensure_jdk JAVA_HOME 11 "$JDK11_URL"
 ensure_jdk JAVA_HOME_17 17 "$JDK17_URL"
-
 ensure_maven
 
-export PATH="$JAVA_HOME/bin:$PATH"
+cat > "$TOOLS_DIR/env.sh" <<EOF
+export JAVA_HOME="$JAVA_HOME"
+export JAVA_HOME_17="$JAVA_HOME_17"
+export MAVEN_HOME="$MAVEN_HOME"
+export PATH="$JAVA_HOME/bin:$MAVEN_HOME/bin:\$PATH"
+EOF
+
+source "$TOOLS_DIR/env.sh"
 
 mvn -f maven/pom.xml install "$@"