Merge pull request #57 from rabestro/feature/setup-mise-and-fix-build

Setup mise and fix build dependencies

Author: rabestro

.github/workflows/build.yml

@@ -11,27 +11,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-        with:
-          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
       - name: Set up JDK 17
         uses: actions/setup-java@v5
         with:
           distribution: 'temurin'
           java-version: 17
-      - name: Cache SonarCloud packages
-        uses: actions/cache@v4
-        with:
-          path: ~/.sonar/cache
-          key: ${{ runner.os }}-sonar
-          restore-keys: ${{ runner.os }}-sonar
       - name: Cache Gradle packages
         uses: actions/cache@v4
         with:
           path: ~/.gradle/caches
           key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
           restore-keys: ${{ runner.os }}-gradle
-      - name: Build and analyze
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        run: ./gradlew build sonarqube --info
+      - name: Build and Test
+        run: ./gradlew build --info

.gitignore

@@ -35,3 +35,6 @@ out/
 .DS_Store
 /algorithm/gradle.properties
 /sample/gradle.properties
+
+# Logs
+spring-shell.log

README.md

@@ -1,5 +1,3 @@
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rabestro_algorithms&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=rabestro_algorithms)
-
 # Graph search algorithms
 
 The project implements an interface for the weighted graph, as well as two algorithms for finding a path in the graph.
@@ -12,6 +10,43 @@ There are implementations and tests for two algorithms:
 The implementation is written in Java 17. [API documentation](https://algorithms.jc.id.lv/docs/api/) is available. You
 can also see the [specifications](https://algorithms.jc.id.lv/docs/spock-reports/) generated with the spock-reports.
 
+## Development Setup with Mise
+
+This project uses [mise](https://mise.jdx.dev/) to manage its toolchain (Java 17 and Gradle 7.5.1) and run development tasks.
+
+To set up the development environment:
+
+1. Install `mise` if you haven't already.
+2. Trust the project configuration:
+   ```shell
+   mise trust
+   ```
+3. Install the required tools (Java and Gradle):
+   ```shell
+   mise install
+   ```
+
+### Available Tasks
+
+You can run various tasks defined in `mise.toml`:
+
+* **Build and Test**: Run the test suite and build the project:
+  ```shell
+  mise run build
+  ```
+* **Run Java Demo**: Launch the Java application demo:
+  ```shell
+  mise run demo-java
+  ```
+* **Run Groovy Demo**: Launch the Groovy script demo:
+  ```shell
+  mise run demo-groovy
+  ```
+* **Run Graph Shell**: Launch the interactive console shell:
+  ```shell
+  mise run demo-shell
+  ```
+
 ## Demo. Graph Shell
 
 To demonstrate the work of search algorithms, I made a small console program '[Graph Shell](graph-shell/README.md)'. The program

algorithm/build.gradle

@@ -3,15 +3,6 @@ plugins {
     id 'java-library'
     id 'maven-publish'
     id 'jacoco'
-    id 'org.sonarqube' version '3.4.0.2513'
-}
-
-sonarqube {
-  properties {
-    property "sonar.projectKey", "rabestro_algorithms"
-    property "sonar.organization", "rabestro"
-    property "sonar.host.url", "https://sonarcloud.io"
-  }
 }
 
 group 'lv.id.jc'

graph-shell/README.md

@@ -8,20 +8,25 @@ To demonstrate the work of search algorithms, I made a small console program. Th
 
 ## Build & Run
 
-To compile the program, use the command:
+You can build and run this program easily using **mise**:
 
 ```shell
-$ gradle assemble
+$ mise run demo-shell
 ```
 
-This command will create an executable jar, so in Linux or macOS you may run the application by
+Alternatively, you can compile and run using Gradle manually (using the toolchain managed by `mise` or system tools):
 
+To compile:
 ```shell
-$ ./build/libs/graph-shell-1.0-SNAPSHOT.jar 
+$ gradle assemble
 ```
 
-On the Windows machine you should run the application using java:
+This command will create an executable JAR. On Linux or macOS you can run it via:
+```shell
+$ ./build/libs/graph-shell-1.0-SNAPSHOT.jar 
+```
 
+On a Windows machine you should run the application using Java:
 ```shell
 $ java -jar ./build/libs/graph-shell-1.0-SNAPSHOT.jar 
 ```