Improve GitHub Actions workflows: add permissions, consolidate build steps, and configure artifact retention

.github/workflows/build.yml

@@ -6,27 +6,45 @@ on:
   pull_request:
     branches: [ main ]
 
+permissions:
+  contents: read
+  pull-requests: read
+
 jobs:
   build:
     name: 🔨 Build and Package
     runs-on: ubuntu-latest
-
+    
     steps:
       - name: 🧩 Checkout source code
         uses: actions/checkout@v4
-
+        
       - name: ☕ Set up Java
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
           java-version: '21'
           cache: maven
-
+
+      - name: 🔧 Make Maven wrapper executable
+        run: chmod +x mvnw
+
       - name: 🧰 Build using Maven Wrapper
         run: ./mvnw -B clean package
-
+        
       - name: 📦 Upload built JAR artifact
+        if: success()
         uses: actions/upload-artifact@v4
         with:
-          name: MyCMD-GUI
+          name: MyCMD-GUI-${{ github.sha }}
           path: target/*.jar
+          retention-days: 30
+
+      - name: 📊 Upload test results (if any)
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-${{ github.sha }}
+          path: target/surefire-reports/
+          retention-days: 7
+        continue-on-error: true

.github/workflows/ci.yml

@@ -19,30 +19,30 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-
+          
       - name: Set up JDK 17
         uses: actions/setup-java@v4
         with:
           java-version: '17'
           distribution: 'temurin'
-
+          
       - name: Cache Maven local repository
         uses: actions/cache@v4
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
           restore-keys: |
             ${{ runner.os }}-maven-
-
-      - name: Build (Maven)
-        run: mvn -B -DskipTests=false package
-
-      - name: Run tests
-        run: mvn test -B
-
-      - name: Upload build artifact (optional)
+
+      - name: Build and Test with Maven
+        run: mvn -B clean package
+        # 'package' phase includes: compile → test → package
+        # Tests run automatically unless -DskipTests=true is specified
+
+      - name: Upload build artifact
         if: success()
         uses: actions/upload-artifact@v4
         with:
           name: mycmd-build
           path: target/*.jar
+          retention-days: 7  # Auto-cleanup after 7 days

pom.xml

@@ -16,6 +16,7 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
         <javafx.version>21</javafx.version>
+        <spotless.version>2.43.0</spotless.version>
     </properties>
 
     <dependencies>
@@ -55,6 +56,7 @@
                 </configuration>
             </plugin>
 
+            <!-- Shade Plugin (for fat jar) -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
@@ -75,6 +77,30 @@
                     </execution>
                 </executions>
             </plugin>
+
+            <!-- Spotless Plugin (Code Formatter) -->
+            <plugin>
+                <groupId>com.diffplug.spotless</groupId>
+                <artifactId>spotless-maven-plugin</artifactId>
+                <version>${spotless.version}</version>
+                <configuration>
+                    <java>
+                        <!-- Uses Google's Java format -->
+                        <googleJavaFormat />
+                    </java>
+                </configuration>
+                <executions>
+                    <!-- Automatically checks formatting during build -->
+                    <execution>
+                        <phase>validate</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
         </plugins>
     </build>
+
 </project>

src/main/java/com/mycmd/App.java

@@ -3,20 +3,18 @@
 import com.mycmd.gui.MainApp;
 import javafx.application.Application;
 
-/**
- * Entry point for MyCMD-GUI.
- */
+/** Entry point for MyCMD-GUI. */
 public class App {
-    public static void main(String[] args) {
-        // Security check to prevent CMD access
-        String launchedFrom = System.getenv("MYCMD_LAUNCHED");
-        if (launchedFrom == null || !launchedFrom.equalsIgnoreCase("true")) {
-            System.out.println("❌ MyCMD-GUI cannot be run directly from CMD.");
-            System.out.println("➡️  Please use the official launcher (MyCMD.bat).");
-            return;
-        }
-
-        // Launch JavaFX GUI
-        Application.launch(MainApp.class, args);
+  public static void main(String[] args) {
+    // Security check to prevent CMD access
+    String launchedFrom = System.getenv("MYCMD_LAUNCHED");
+    if (launchedFrom == null || !launchedFrom.equalsIgnoreCase("true")) {
+      System.out.println("❌ MyCMD-GUI cannot be run directly from CMD.");
+      System.out.println("➡️  Please use the official launcher (MyCMD.bat).");
+      return;
     }
+
+    // Launch JavaFX GUI
+    Application.launch(MainApp.class, args);
+  }
 }

src/main/java/com/mycmd/Command.java

@@ -2,12 +2,11 @@
 
 import java.io.IOException;
 
-/**
- * Interfaace for all commands.
- * Every command impleements this
- */
+/** Interfaace for all commands. Every command impleements this */
 public interface Command {
-    void execute(String[] args, ShellContext context) throws IOException;
-    String description();
-    String usage();
+  void execute(String[] args, ShellContext context) throws IOException;
+
+  String description();
+
+  String usage();
 }

src/main/java/com/mycmd/CommandRegistry.java

@@ -3,21 +3,19 @@
 import java.util.HashMap;
 import java.util.Map;
 
-/**
- * Registers and retrieves commands by name.
- */
+/** Registers and retrieves commands by name. */
 public class CommandRegistry {
-    private final Map<String, Command> commands = new HashMap<>();
+  private final Map<String, Command> commands = new HashMap<>();
 
-    public void register(String name, Command cmd) {
-        commands.put(name.toLowerCase(), cmd);
-    }
+  public void register(String name, Command cmd) {
+    commands.put(name.toLowerCase(), cmd);
+  }
 
-    public Command get(String name) {
-        return commands.get(name.toLowerCase());
-    }
+  public Command get(String name) {
+    return commands.get(name.toLowerCase());
+  }
 
-    public Map<String, Command> getAll() {
-        return commands;
-    }
+  public Map<String, Command> getAll() {
+    return commands;
+  }
 }

src/main/java/com/mycmd/ConsoleShell.java

@@ -2,26 +2,24 @@
 
 import java.util.Scanner;
 
-/**
- * Developer console mode for debugging.
- */
+/** Developer console mode for debugging. */
 public class ConsoleShell {
 
-    public static void main(String[] args) {
-        CommandRegistry registry = new CommandRegistry();
-        ShellContext context = new ShellContext();
-        ShellEngine engine = new ShellEngine(registry, context);
+  public static void main(String[] args) {
+    CommandRegistry registry = new CommandRegistry();
+    ShellContext context = new ShellContext();
+    ShellEngine engine = new ShellEngine(registry, context);
 
-        Scanner sc = new Scanner(System.in);
-        System.out.println("MyCMD Developer Console Mode\n(Type 'exit' to quit)");
+    Scanner sc = new Scanner(System.in);
+    System.out.println("MyCMD Developer Console Mode\n(Type 'exit' to quit)");
 
-        while (true) {
-            System.out.print("> ");
-            String input = sc.nextLine();
-            if (input.equalsIgnoreCase("exit")) break;
-            engine.execute(input);
-        }
-
-        sc.close();
+    while (true) {
+      System.out.print("> ");
+      String input = sc.nextLine();
+      if (input.equalsIgnoreCase("exit")) break;
+      engine.execute(input);
     }
+
+    sc.close();
+  }
 }

src/main/java/com/mycmd/ShellContext.java

@@ -4,39 +4,37 @@
 import java.util.HashMap;
 import java.util.Map;
 
-
 public class ShellContext {
 
-    private File currentDir;
-    private final Map<String, String> aliases;
+  private File currentDir;
+  private final Map<String, String> aliases;
 
-    private Scanner scanner;
+  private Scanner scanner;
 
-    public ShellContext() {
-        this.currentDir = new File(System.getProperty("user.dir"));
-        this.aliases = new HashMap<>();
-    }
+  public ShellContext() {
+    this.currentDir = new File(System.getProperty("user.dir"));
+    this.aliases = new HashMap<>();
+  }
 
-    public File getCurrentDir() {
-        return currentDir;
-    }
+  public File getCurrentDir() {
+    return currentDir;
+  }
 
-    public void setCurrentDir(File dir) {
-        if (dir != null && dir.exists() && dir.isDirectory()) {
-            this.currentDir = dir;
-        }
+  public void setCurrentDir(File dir) {
+    if (dir != null && dir.exists() && dir.isDirectory()) {
+      this.currentDir = dir;
     }
+  }
 
-    public Map<String, String> getAliases() {
-        return aliases;
-    }
+  public Map<String, String> getAliases() {
+    return aliases;
+  }
 
-    public void addAlias(String name, String command) {
-        aliases.put(name, command);
-    }
+  public void addAlias(String name, String command) {
+    aliases.put(name, command);
+  }
 
-    public String resolveAlias(String cmd) {
-        return aliases.getOrDefault(cmd, cmd);
-    }
+  public String resolveAlias(String cmd) {
+    return aliases.getOrDefault(cmd, cmd);
+  }
 }
-

src/main/java/com/mycmd/ShellEngine.java

@@ -3,36 +3,34 @@
 import java.io.IOException;
 import java.util.Arrays;
 
-/**
- * Central execution engine.
- */
+/** Central execution engine. */
 public class ShellEngine {
 
-    private final CommandRegistry registry;
-    private final ShellContext context;
+  private final CommandRegistry registry;
+  private final ShellContext context;
 
-    public ShellEngine(CommandRegistry registry, ShellContext context) {
-        this.registry = registry;
-        this.context = context;
-    }
+  public ShellEngine(CommandRegistry registry, ShellContext context) {
+    this.registry = registry;
+    this.context = context;
+  }
 
-    public void execute(String input) {
-        if (input == null || input.trim().isEmpty()) return;
+  public void execute(String input) {
+    if (input == null || input.trim().isEmpty()) return;
 
-        String[] parts = input.trim().split("\\s+");
-        String cmdName = context.resolveAlias(parts[0]);
-        String[] args = Arrays.copyOfRange(parts, 1, parts.length);
+    String[] parts = input.trim().split("\\s+");
+    String cmdName = context.resolveAlias(parts[0]);
+    String[] args = Arrays.copyOfRange(parts, 1, parts.length);
 
-        Command cmd = registry.get(cmdName);
-        if (cmd == null) {
-            System.out.println("❌ Unknown command: " + cmdName);
-            return;
-        }
+    Command cmd = registry.get(cmdName);
+    if (cmd == null) {
+      System.out.println("❌ Unknown command: " + cmdName);
+      return;
+    }
 
-        try {
-            cmd.execute(args, context);
-        } catch (IOException e) {
-            System.out.println("⚠️ Error executing command: " + e.getMessage());
-        }
+    try {
+      cmd.execute(args, context);
+    } catch (IOException e) {
+      System.out.println("⚠️ Error executing command: " + e.getMessage());
     }
+  }
 }