feat(gitpod): Install SDKMAN in GitHub runners and GitPod, and keep JDK versions up-to-date

.github/workflows/updatecli.yaml

@@ -0,0 +1,36 @@
+name: updatecli
+on:
+  # Allow to be run manually
+  workflow_dispatch:
+  schedule:
+    # Run once per week (to avoid alert fatigue)
+    - cron: '0 2 * * 1' # Every Monday at 2am UTC
+  push:
+  pull_request:
+jobs:
+  updatecli:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'jenkinsci'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Updatecli in the runner
+        uses: updatecli/[email protected]
+
+      - name: Install SDKMAN in the runner
+        run: ./updatecli/scripts/install-sdk.sh
+
+      - name: Install needed JDKs in the runner
+        run: ./updatecli/scripts/install-jdk-versions.sh
+
+      - name: Run Updatecli in Dry Run mode
+        run: updatecli diff --config ./updatecli/updatecli.d --values ./updatecli/values.github-action.yaml
+        env:
+          UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run Updatecli in Apply mode
+        if: github.ref == 'refs/heads/main'
+        run: updatecli apply --config ./updatecli/updatecli.d --values ./updatecli/values.github-action.yaml
+        env:
+          UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitpod/Dockerfile

@@ -5,6 +5,12 @@
 # Start from a base image that includes JDK 17 and Git. This serves as the foundation for the development environment.
 FROM gitpod/workspace-java-17
 
+# Define the versions of the JDKs to install. This is used by the `sdk install java` command to install the specified JDK.
+ARG JDK8_PACKAGE=8.0.422-tem
+ARG JDK11_PACKAGE=11.0.24-tem
+ARG JDK17_PACKAGE=17.0.12-tem
+ARG JDK21_PACKAGE=21.0.4-tem
+
 # Update the package list and install Maven. Maven is required for building Java projects, including Jenkins plugins.
 # The `apt-get update` command updates the list of available packages and their versions, but it does not install or
 # upgrade any packages. The `apt-get install -y maven` command installs Maven without requiring confirmation from the user.
@@ -19,11 +25,18 @@ RUN file="$HOME/.bashrc.d/770-scm_token.sh" \
     && printf '%s\n' 'if [[ "${GITPOD_WORKSPACE_CONTEXT_URL:-}" == *gitlab* ]]; then : "gitlab"; else : "github"; fi; scm_name="$_"' > "${file}" \
     && printf 'export SCM_TOKEN="$(%s)"\n' "gp credential-helper get <<<host=\${scm_name}.com | sed -n 's/^password=//p'" >> "${file}"
 
-# Install the gh cli tool \
+# Install the gh cli tool 
 RUN (type -p wget >/dev/null || (sudo apt update && sudo apt-get install wget -y)) \
     && sudo mkdir -p -m 755 /etc/apt/keyrings \
     && wget -qO- https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo tee /etc/apt/keyrings/githubcli-archive-keyring.gpg > /dev/null \
     && sudo chmod go+r /etc/apt/keyrings/githubcli-archive-keyring.gpg \
     && echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
     && sudo apt update \
     && sudo apt install gh -y
+
+ # Initialize SDKMAN and install the various JDKs thanks to SDKMAN
+RUN /bin/bash -c "source \"$HOME/.sdkman/bin/sdkman-init.sh\" && \
+    yes | sdk install java \"$JDK8_PACKAGE\" \
+    && yes | sdk install java \"$JDK11_PACKAGE\" \
+    && yes | sdk install java \"$JDK21_PACKAGE\" \
+    && yes | sdk install java \"$JDK17_PACKAGE\""

plugin-modernizer-cli/src/main/resources/sdkman.properties

@@ -0,0 +1,12 @@
+# sdkman.properties
+# This properties file defines the specific versions of the Temurin JDK to be installed using SDKMAN.
+# Each property specifies the version of the JDK package corresponding to its major version number.
+
+JDK8_PACKAGE=8.0.422-tem  # JDK 8 package version
+JAVA_8_HOME=$HOME/.sdkman/candidates/java/8.0.422-tem
+JDK11_PACKAGE=11.0.24-tem # JDK 11 package version
+JAVA_11_HOME=$HOME/.sdkman/candidates/java/11.0.24-tem
+JDK17_PACKAGE=17.0.12-tem # JDK 17 package version
+JAVA_17_HOME=$HOME/.sdkman/candidates/java/17.0.12-tem
+JDK21_PACKAGE=21.0.4-tem  # JDK 21 package version
+JAVA_21_HOME=$HOME/.sdkman/candidates/java/21.0.4-tem

updatecli/scripts/get-java-home.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+# Store the current directory
+current_dir=$(pwd)
+
+# Store the directory of the current script
+script_dir=$(dirname "$0")
+
+# Check if exactly one argument is provided
+if [ "$#" -ne 1 ]; then
+    echo "Usage: $0 <major_java_version>"
+    exit 1
+fi
+
+major_version=$1
+
+# Change to the directory where the script is located
+cd "$script_dir" || exit
+
+# Call install-sdk.sh and redirect output
+# For silence:
+./install-sdk.sh > /dev/null 2>&1
+# Or, to redirect all output to stderr:
+#./install-sdk.sh 2>&1 >&2
+
+# Initialize SDKMAN
+if [[ -s "$HOME/.sdkman/bin/sdkman-init.sh" ]]; then
+    source "$HOME/.sdkman/bin/sdkman-init.sh"
+    # Call install-jdk-versions.sh using the script directory
+    ./install-jdk-versions.sh > /dev/null 2>&1
+else
+    echo "SDKMAN is not installed or not found."
+    exit 2
+fi
+
+# Change back to the original directory
+cd "$current_dir" || exit
+
+# Retrieve the version identifier for the requested major version of Temurin JDK
+identifier=$(PAGER=cat sdk list java | grep -E " $major_version\\.0.*-tem" | awk -v ver="$major_version" '$0 ~ " " ver "\\.0.*-tem" {print $NF}' | head -n 1)
+
+if [ -z "$identifier" ]; then
+    echo "No Temurin JDK version found for Java $major_version"
+    exit 3
+fi
+
+# Get JAVA_HOME for the specified version
+java_home=$(sdk home java "$identifier")
+
+# Replace the expanded $HOME path with the literal $HOME string
+java_home_modified=$(echo "$java_home" | sed "s|${HOME}|\\\$HOME|g")
+
+if [ -z "$java_home_modified" ]; then
+    echo "JAVA_HOME could not be found for Java $major_version"
+    exit 4
+fi
+
+echo "$java_home_modified"

updatecli/scripts/get-jdk-versions.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+# Store the current directory
+current_dir=$(pwd)
+
+# Check if a version argument was provided
+if [ "$#" -ne 1 ]; then
+    echo "Usage: $0 <major_java_version>" >&2
+    exit 1
+fi
+
+major_version=$1
+
+# Change to the directory where the script is located
+cd "$(dirname "$0")" || exit
+
+# Call install-sdk.sh and redirect output
+# For silence:
+./install-sdk.sh > /dev/null 2>&1
+# Or, to redirect all output to stderr:
+#./install-sdk.sh 2>&1 >&2
+
+# Initialize SDKMAN
+if [[ -s "$HOME/.sdkman/bin/sdkman-init.sh" ]]; then
+    source "$HOME/.sdkman/bin/sdkman-init.sh"
+    install-jdk-versions.sh > /dev/null 2>&1
+else
+    echo "SDKMAN is not installed or not found."
+    exit 2
+fi
+
+# Change back to the original directory
+cd "$current_dir" || exit
+
+# Initialize SDKMAN
+source "$HOME/.sdkman/bin/sdkman-init.sh"
+
+# Find and output the Temurin JDK version identifier for the given major version
+identifier=$(PAGER=cat sdk list java | grep -E " $major_version\\.0.*-tem" | awk -v ver="$major_version" '$0 ~ " " ver "\\.0.*-tem" {print $NF}' | head -n 1)
+
+if [ -n "$identifier" ]; then
+    echo "$identifier"
+else
+    echo "No Temurin JDK version found for Java $major_version" >&2
+    exit 2
+fi

updatecli/scripts/install-jdk-versions.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+# Determine the directory of the current script
+script_dir=$(dirname "$0")
+
+# Check if SDKMAN is installed
+if [[ ! -s "$HOME/.sdkman/bin/sdkman-init.sh" ]]; then
+    echo "SDKMAN is not installed. Attempting to install SDKMAN..."
+    # Attempt to install SDKMAN by calling install-sdk.sh from the same directory
+    if [[ -x "$script_dir/install-sdk.sh" ]]; then
+        "$script_dir/install-sdk.sh"
+        # Check if SDKMAN is successfully installed
+        if [[ ! -s "$HOME/.sdkman/bin/sdkman-init.sh" ]]; then
+            echo "Failed to install SDKMAN. Please install SDKMAN manually."
+            exit 1
+        fi
+    else
+        echo "install-sdk.sh script not found in $script_dir"
+        exit 1
+    fi
+fi
+
+# Initialize SDKMAN
+source "$HOME/.sdkman/bin/sdkman-init.sh"
+
+# Declare the JDK versions you're interested in
+declare -a jdk_versions=("8" "11" "17" "21")
+
+# Loop through each JDK version
+for version in "${jdk_versions[@]}"; do
+    # Use sdk list java with --no-pager or pipe through cat to avoid pager behavior
+    identifier=$(PAGER=cat sdk list java | grep -E " $version\\.0.*-tem" | awk -v ver="$version" '$0 ~ " " ver "\\.0.*-tem" {print $NF}' | head -n 1)
+    if [ -n "$identifier" ]; then
+        echo "Installing Temurin JDK version $version with identifier $identifier"
+        # Install the JDK version using SDKMAN
+        yes | sdk install java "$identifier"
+    else
+        echo "No Temurin JDK version found for $version"
+    fi
+done

updatecli/scripts/install-sdk.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# This script installs SDKMAN, a tool for managing parallel versions of multiple Software Development Kits on most Unix-based systems.
+
+# Define SDKMAN installation URL
+SDKMAN_URL="https://get.sdkman.io"
+
+# Check if SDKMAN is already installed by checking if the sdkman-init.sh script exists
+if [ -f "$HOME/.sdkman/bin/sdkman-init.sh" ]; then
+    echo "SDKMAN is already installed."
+else
+    # Download and run the SDKMAN installation script
+    echo "Installing SDKMAN..."
+    curl -s "$SDKMAN_URL" | bash
+
+    # Source the SDKMAN initialization script to make the `sdk` command available in the current shell session
+    source "$HOME/.sdkman/bin/sdkman-init.sh"
+
+    echo "SDKMAN installation completed."
+fi
+[[ -s "$HOME/.sdkman/bin/sdkman-init.sh" ]] && source "$HOME/.sdkman/bin/sdkman-init.sh"
+# Verify SDKMAN installation by checking the sdk version
+sdk version