Disable recompilation in CI by default (#320)

Author: shartte

LEGACY.md

@@ -104,14 +104,15 @@ legacyForge {
 ```
 
 ## Disabling Decompilation and Recompilation
-As of MDG Legacy 2.0.124, the decompilation/recompilation pipeline can be disabled, similarly to the regular plugin.
-To disable it in CI, use the following:
+As of MDG Legacy 2.0.124, the decompilation/recompilation pipeline can be disabled, similarly to the regular plugin,
+and starting in MDG 2.0.136, it is disabled by default in CI environments (if the `CI` environment variable is set to `true`).
+
+To disable it manually, use the following:
 ```groovy
 legacyForge {
     enable {
         forgeVersion = "..." // or mcpVersion = "..." if running in Vanilla mode
-        // Disable recompilation if the "CI" environment variable is set to true. It is automatically set by GitHub Actions.
-        disableRecompilation = System.getenv("CI") == "true"
+        disableRecompilation = true
     }
 }
 ```

README.md

@@ -112,22 +112,23 @@ neoForge {
 By default, MDG will use the [NeoForm](https://github.com/neoforged/NeoForm) decompilation/recompilation pipeline to produce
 Minecraft sources and a matching compiled game jar. This leads to a great debugging experience, at the cost of longer setup times.
 
-As of MDG 2.0.124, an alternative pipeline can be used, which will skip decompilation and recompilation entirely!
-We recommend leaving recompilation on by default, but disabling it when running on CI such as GitHub Actions.
+As of MDG 2.0.124, an alternative pipeline can be used, which will skip decompilation and recompilation entirely.
+As of MDG 2.0.136, this pipeline will be used by default in CI/CD pipelines, if the `CI` environment variable is `true`.
+This is true by default in many CI/CD systems such as GitHub Actions.
 
-To do so, replace:
+To control this setting manually, replace:
 ```groovy
 neoForge {
     version = "..." // or neoFormVersion = "..."
 }
 ```
+
 By:
 ```groovy
 neoForge {
     enable {
         version = "..." // or neoFormVersion = "..."
-        // Disable recompilation if the "CI" environment variable is set to true. It is automatically set by GitHub Actions.
-        disableRecompilation = System.getenv("CI") == "true"
+        disableRecompilation = true
     }
 }
 ```

legacytest/build.gradle

@@ -13,10 +13,7 @@ java {
 }
 
 legacyForge {
-    enable {
-        mcpVersion = '1.19.2'
-        disableRecompilation = System.getenv("CI") == "true"
-    }
+    mcpVersion = '1.19.2'
 }
 
 publishing {

legacytest/forge/build.gradle

@@ -32,10 +32,7 @@ dependencies {
 }
 
 legacyForge {
-    enable {
-        forgeVersion = '1.20.1-47.3.12'
-        disableRecompilation = System.getenv("CI") == "true"
-    }
+    version = '1.20.1-47.3.12'
     runs {
         client {
             client()

legacytest/forgedownstream/build.gradle

@@ -16,10 +16,7 @@ dependencies {
 }
 
 legacyForge {
-    enable {
-        forgeVersion = '1.20.1-47.3.0'
-        disableRecompilation = System.getenv("CI") == "true"
-    }
+    version = '1.20.1-47.3.0'
 }
 
 var copyJarJar = tasks.register('copyJarJar', Copy) {

src/legacy/java/net/neoforged/moddevgradle/legacyforge/dsl/LegacyForgeModdingSettings.java

@@ -20,7 +20,7 @@ public abstract class LegacyForgeModdingSettings {
 
     private Set<SourceSet> enabledSourceSets = new HashSet<>();
 
-    private boolean disableRecompilation = false;
+    private boolean disableRecompilation = "true".equals(System.getenv("CI"));
 
     private boolean obfuscateJar = true;
 

src/main/java/net/neoforged/moddevgradle/dsl/ModdingVersionSettings.java

@@ -17,7 +17,7 @@ public abstract class ModdingVersionSettings {
 
     private Set<SourceSet> enabledSourceSets = new HashSet<>();
 
-    private boolean disableRecompilation = false;
+    private boolean disableRecompilation = "true".equals(System.getenv("CI"));
 
     @Inject
     public ModdingVersionSettings(Project project) {

src/main/java/net/neoforged/moddevgradle/internal/ModDevArtifactsWorkflow.java

@@ -73,6 +73,10 @@ public static ModDevArtifactsWorkflow create(Project project,
             throw new InvalidUserCodeException("You cannot enable modding in the same project twice.");
         }
 
+        if (disableRecompilation) {
+            project.getLogger().lifecycle("Creating Minecraft artifacts without recompilation.");
+        }
+
         var ideIntegration = IdeIntegration.of(project, branding);
 
         // We use this directory to store intermediate files used during moddev

testproject/build.gradle

@@ -36,10 +36,7 @@ test {
 }
 
 neoForge {
-    enable {
-        version = project.neoforge_version
-        disableRecompilation = System.getenv("CI") == "true"
-    }
+    version = project.neoforge_version
     addModdingDependenciesTo(sourceSets.api)
 
     validateAccessTransformers = true

testproject/common/build.gradle

@@ -7,10 +7,7 @@ plugins {
 }
 
 neoForge {
-    enable {
-        neoFormVersion = "1.21-20240613.152323"
-        disableRecompilation = System.getenv("CI") == "true"
-    }
+    neoFormVersion = "1.21-20240613.152323"
 
     accessTransformers {
         validateAccessTransformers = true