Merge branch 'main' into release-please--branches--main

aravind666 · web-flow · commit ac7fc89ca1bc · 2026-02-08T23:09:11.000+05:30
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,13 @@
+version: 2
+updates:
+  # Enable version updates for Gradle dependencies
+  - package-ecosystem: "gradle"
+    # Look for build.gradle files in the root directory
+    directory: "/"
+    schedule:
+      interval: "daily"
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/checkstyle.yml b/.github/workflows/checkstyle.yml
@@ -16,19 +16,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - name: Extract Java version from .tool-versions
-      id: java-version
-      run: |
-        TOOL_VERSION=$(grep '^java' .tool-versions | awk '{print $2}')
-        JAVA_DIST=$(echo $TOOL_VERSION | cut -d'-' -f1)
-        JAVA_VERSION=$(echo $TOOL_VERSION | cut -d'-' -f2)
-        echo "distribution=$JAVA_DIST" >> $GITHUB_OUTPUT
-        echo "version=$JAVA_VERSION" >> $GITHUB_OUTPUT
-    - name: Set up JDK from .tool-versions
-      uses: actions/setup-java@v4
-      with:
-        java-version: ${{ steps.java-version.outputs.version }}
-        distribution: ${{ steps.java-version.outputs.distribution }}
+    - name: Setup asdf and install tools
+      uses: asdf-vm/actions/install@v3
     - name: Setup Gradle
       uses: gradle/actions/setup-gradle@v3
     - name: Build with Gradle
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -13,19 +13,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - name: Extract Java version from .tool-versions
-      id: java-version
-      run: |
-        TOOL_VERSION=$(grep '^java' .tool-versions | awk '{print $2}')
-        JAVA_DIST=$(echo $TOOL_VERSION | cut -d'-' -f1)
-        JAVA_VERSION=$(echo $TOOL_VERSION | cut -d'-' -f2)
-        echo "distribution=$JAVA_DIST" >> $GITHUB_OUTPUT
-        echo "version=$JAVA_VERSION" >> $GITHUB_OUTPUT
-    - name: Set up JDK from .tool-versions
-      uses: actions/setup-java@v4
-      with:
-        java-version: ${{ steps.java-version.outputs.version }}
-        distribution: ${{ steps.java-version.outputs.distribution }}
+    - name: Setup asdf and install tools
+      uses: asdf-vm/actions/install@v3
     - name: Setup Gradle
       uses: gradle/actions/setup-gradle@v3
     - name: Build with Gradle
diff --git a/.github/workflows/cpd.yml b/.github/workflows/cpd.yml
@@ -15,19 +15,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Extract Java version from .tool-versions
-        id: java-version
-        run: |
-          TOOL_VERSION=$(grep '^java' .tool-versions | awk '{print $2}')
-          JAVA_DIST=$(echo $TOOL_VERSION | cut -d'-' -f1)
-          JAVA_VERSION=$(echo $TOOL_VERSION | cut -d'-' -f2)
-          echo "distribution=$JAVA_DIST" >> $GITHUB_OUTPUT
-          echo "version=$JAVA_VERSION" >> $GITHUB_OUTPUT
-      - name: Set up JDK from .tool-versions
-        uses: actions/setup-java@v4
-        with:
-          java-version: ${{ steps.java-version.outputs.version }}
-          distribution: ${{ steps.java-version.outputs.distribution }}
+      - name: Setup asdf and install tools
+        uses: asdf-vm/actions/install@v3
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v3
       - name: Run checkstyle on Source and Test
diff --git a/.github/workflows/dependabot.yml b/.github/workflows/dependabot.yml
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -13,19 +13,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Extract Java version from .tool-versions
-      id: java-version
-      run: |
-        TOOL_VERSION=$(grep '^java' .tool-versions | awk '{print $2}')
-        JAVA_DIST=$(echo $TOOL_VERSION | cut -d'-' -f1)
-        JAVA_VERSION=$(echo $TOOL_VERSION | cut -d'-' -f2)
-        echo "distribution=$JAVA_DIST" >> $GITHUB_OUTPUT
-        echo "version=$JAVA_VERSION" >> $GITHUB_OUTPUT
-    - name: Set up JDK from .tool-versions
-      uses: actions/setup-java@v4
-      with:
-        java-version: ${{ steps.java-version.outputs.version }}
-        distribution: ${{ steps.java-version.outputs.distribution }}
+    - name: Setup asdf and install tools
+      uses: asdf-vm/actions/install@v3
     - name: Setup Gradle
       uses: gradle/actions/setup-gradle@v3
     - name: Build Binary Executable
diff --git a/.github/workflows/mutation.yml b/.github/workflows/mutation.yml
@@ -15,19 +15,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Extract Java version from .tool-versions
-        id: java-version
-        run: |
-          TOOL_VERSION=$(grep '^java' .tool-versions | awk '{print $2}')
-          JAVA_DIST=$(echo $TOOL_VERSION | cut -d'-' -f1)
-          JAVA_VERSION=$(echo $TOOL_VERSION | cut -d'-' -f2)
-          echo "distribution=$JAVA_DIST" >> $GITHUB_OUTPUT
-          echo "version=$JAVA_VERSION" >> $GITHUB_OUTPUT
-      - name: Set up JDK from .tool-versions
-        uses: actions/setup-java@v4
-        with:
-          java-version: ${{ steps.java-version.outputs.version }}
-          distribution: ${{ steps.java-version.outputs.distribution }}
+      - name: Setup asdf and install tools
+        uses: asdf-vm/actions/install@v3
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v3
       - name: Run Mutation Analysis
diff --git a/.github/workflows/pmd.yml b/.github/workflows/pmd.yml
@@ -13,19 +13,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Extract Java version from .tool-versions
-        id: java-version
-        run: |
-          TOOL_VERSION=$(grep '^java' .tool-versions | awk '{print $2}')
-          JAVA_DIST=$(echo $TOOL_VERSION | cut -d'-' -f1)
-          JAVA_VERSION=$(echo $TOOL_VERSION | cut -d'-' -f2)
-          echo "distribution=$JAVA_DIST" >> $GITHUB_OUTPUT
-          echo "version=$JAVA_VERSION" >> $GITHUB_OUTPUT
-      - name: Set up JDK from .tool-versions
-        uses: actions/setup-java@v4
-        with:
-          java-version: ${{ steps.java-version.outputs.version }}
-          distribution: ${{ steps.java-version.outputs.distribution }}
+      - name: Setup asdf and install tools
+        uses: asdf-vm/actions/install@v3
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v3
       - name: Run PMD on sources
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -29,21 +29,9 @@ jobs:
         if: ${{ steps.release.outputs.release_created }}
         uses: actions/checkout@v4
         
-      - name: Extract Java version from .tool-versions
+      - name: Setup asdf and install tools
         if: ${{ steps.release.outputs.release_created }}
-        id: java-version
-        run: |
-          TOOL_VERSION=$(grep '^java' .tool-versions | awk '{print $2}')
-          JAVA_DIST=$(echo $TOOL_VERSION | cut -d'-' -f1)
-          JAVA_VERSION=$(echo $TOOL_VERSION | cut -d'-' -f2)
-          echo "distribution=$JAVA_DIST" >> $GITHUB_OUTPUT
-          echo "version=$JAVA_VERSION" >> $GITHUB_OUTPUT
-      - name: Set up JDK from .tool-versions
-        if: ${{ steps.release.outputs.release_created }}
-        uses: actions/setup-java@v4
-        with:
-          java-version: ${{ steps.java-version.outputs.version }}
-          distribution: ${{ steps.java-version.outputs.distribution }}
+        uses: asdf-vm/actions/install@v3
           
       - name: Setup Gradle
         if: ${{ steps.release.outputs.release_created }}
diff --git a/.github/workflows/spotbugs.yml b/.github/workflows/spotbugs.yml
@@ -13,19 +13,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Extract Java version from .tool-versions
-        id: java-version
-        run: |
-          TOOL_VERSION=$(grep '^java' .tool-versions | awk '{print $2}')
-          JAVA_DIST=$(echo $TOOL_VERSION | cut -d'-' -f1)
-          JAVA_VERSION=$(echo $TOOL_VERSION | cut -d'-' -f2)
-          echo "distribution=$JAVA_DIST" >> $GITHUB_OUTPUT
-          echo "version=$JAVA_VERSION" >> $GITHUB_OUTPUT
-      - name: Set up JDK from .tool-versions
-        uses: actions/setup-java@v4
-        with:
-          java-version: ${{ steps.java-version.outputs.version }}
-          distribution: ${{ steps.java-version.outputs.distribution }}
+      - name: Setup asdf and install tools
+        uses: asdf-vm/actions/install@v3
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v3
       - name: Run Spotbugs on sources
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,7 +1,32 @@
 # Contributing
 
 This project welcomes contributions and suggestions. 
-When you submit a pull request, we have checks which run on your PR for standards that we expect .
+When you submit a pull request, we have checks which run on your PR for standards that we expect.
+
+## Prerequisites
+
+Before contributing, ensure you have the following installed:
+
+1. **asdf** - Tool version manager
+   - Installation guide: https://asdf-vm.com/guide/getting-started.html
+   - Install required plugins:
+     ```bash
+     asdf plugin add java
+     asdf plugin add gradle
+     ```
+
+2. **Install project tools**
+   - Navigate to the project directory and run:
+     ```bash
+     asdf install
+     ```
+   - This will install the Java and Gradle versions specified in `.tool-versions`
+
+3. **Verify installation**
+   ```bash
+   java -version
+   gradle -version
+   ```
 
 ## Code of Conduct
 
@@ -37,6 +62,28 @@ Check out the links below to get started.
 - Be prepared to discuss a feature and take feedback.
 - Include unit tests and updates documentation to complement the change.
 
+### Development workflow
+
+1. **Set up your environment**
+   ```bash
+   asdf install  # Install Java and Gradle from .tool-versions
+   ```
+
+2. **Run quality checks locally**
+   ```bash
+   ./gradlew clean build pitest shadowJar
+   ```
+   This runs all quality gates including tests, PMD, CPD, Checkstyle, code coverage, and mutation testing.
+
+3. **Make your changes**
+   - Follow the existing code style and conventions
+   - Ensure all quality checks pass before submitting a PR
+
+4. **Submit a pull request**
+   - Target the `main` branch
+   - Ensure CI workflows pass on your PR
+   - Address any review feedback promptly
+
 [learn-git]: https://help.github.com/en/articles/git-and-github-learning-resources
 [github-flow]: https://guides.github.com/introduction/flow/
 [github-signup]: https://github.com/signup/free
diff --git a/README.md b/README.md
@@ -23,14 +23,27 @@ We asked ourselves the same question! Why create a new tool when there were many
 
 ## How to use Ceberus? 
 ### Build Cerberus from source
-To build Cerberus, you will need a JDK 8 installed in your system. 
-The final output of build is an executable JAR. We have created gradle tasks to achieve the same, review our build.gradle file for more details.  
+Cerberus uses [asdf](https://asdf-vm.com/) for managing Java and Gradle versions. The required tool versions are specified in the `.tool-versions` file.
 
+**Prerequisites:**
+- Install [asdf](https://asdf-vm.com/guide/getting-started.html)
+- Install asdf plugins: `asdf plugin add java` and `asdf plugin add gradle`
+
+**Build Steps:**
 1. Clone the repository
-`git clone https://github.com/philips-software/cerberus.git`
-2. Build it using the following command
-`./gradlew clean build shadowJar`
-The executable jar will be generated in the build/libs folder. 
+   ```bash
+   git clone https://github.com/philips-software/cerberus.git
+   cd cerberus
+   ```
+2. Install tools from .tool-versions
+   ```bash
+   asdf install
+   ```
+3. Build the executable JAR
+   ```bash
+   ./gradlew clean build shadowJar
+   ```
+   The executable jar will be generated in the build/libs folder. 
 
 ### Run Cerberus as a command line tool
 Once the jar gets generated,  use the jar to run Cerberus
