Standardize environment variables names on _DIR instead of _FOLDER (

#3637)

Follows suit from #3530. This
hasn't been released in a stable version yet so we are free to change it

.config/mill-version

@@ -1 +1 @@
-0.12.0-RC2-38-029986
+0.12.0-RC2-65-26cbc8

.github/workflows/run-mill-action.yml

@@ -87,4 +87,4 @@ jobs:
           path: .
           name: ${{ inputs.os }}-artifact
           include-hidden-files: true
-        if: ${{ inputs.populate_cache }}
+        if: ${{ inputs.populate_cache }}

.github/workflows/run-tests.yml

@@ -11,8 +11,6 @@ name: Run Tests
 
 on:
   push:
-    branches:
-      - main
   pull_request:
   workflow_dispatch:
 

contrib/buildinfo/test/src/mill/contrib/buildinfo/BuildInfoTests.scala

@@ -86,7 +86,7 @@ object BuildInfoTests extends TestSuite {
     )
   }
 
-  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "buildinfo"
+  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "buildinfo"
 
   def buildInfoSourcePath(eval: UnitTester) =
     eval.outPath / "buildInfoSources.dest/foo/BuildInfo.scala"

contrib/checkstyle/test/src/mill/contrib/checkstyle/CheckstyleModuleTest.scala

@@ -10,7 +10,7 @@ object CheckstyleModuleTest extends TestSuite {
 
   def tests: Tests = Tests {
 
-    val resources: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+    val resources: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
 
     // violations (for version 10.18.1) in "non-compatible" module
     val violations: Seq[String] =

contrib/checkstyle/test/src/mill/contrib/checkstyle/CheckstyleXsltModuleTest.scala

@@ -10,7 +10,7 @@ object CheckstyleXsltModuleTest extends TestSuite {
 
   def tests: Tests = Tests {
 
-    val resources: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+    val resources: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
 
     test("checkstyle generates XSLT output reports") {
 

contrib/docker/test/src/mill/contrib/docker/DockerModuleTest.scala

@@ -45,7 +45,7 @@ object DockerModuleTest extends TestSuite {
 
   val testArtifactName = "mill-docker-contrib-test"
 
-  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "docker"
+  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "docker"
 
   val multineRegex = "\\R+".r
 

contrib/errorprone/test/src/mill/contrib/errorprone/ErrorProneTests.scala

@@ -16,7 +16,7 @@ object ErrorProneTests extends TestSuite {
     ))
   }
 
-  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "simple"
+  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "simple"
 
   def tests = Tests {
     test("reference") {

contrib/flyway/test/src/mill/contrib/flyway/BuildTest.scala

@@ -10,7 +10,7 @@ object BuildTest extends TestSuite {
   object Build extends TestBaseModule {
     object build extends FlywayModule {
 
-      val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+      val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
       override def resources = Task.Sources(resourceFolder)
 
       def h2 = ivy"com.h2database:h2:2.1.214"

contrib/jmh/test/src/mill/contrib/jmh/JmhModuleTest.scala

@@ -16,7 +16,7 @@ object JmhModuleTest extends TestSuite {
     override def scalaVersion = sys.props.getOrElse("TEST_SCALA_2_13_VERSION", ???)
     override def jmhCoreVersion = "1.35"
   }
-  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "jmh"
+  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "jmh"
 
   def tests = Tests {
     test("jmh") {

contrib/playlib/test/src/mill/playlib/PlayModuleTests.scala

@@ -16,7 +16,7 @@ object PlayModuleTests extends TestSuite with PlayTestSuite {
       override def ivyDeps = Task { super.ivyDeps() ++ Agg(ws()) }
     }
   }
-  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "playmulti"
+  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "playmulti"
 
   def tests: Tests = Tests {
     test("layout") {

contrib/playlib/test/src/mill/playlib/PlaySingleApiModuleTests.scala

@@ -13,7 +13,7 @@ object PlaySingleApiModuleTests extends TestSuite with PlayTestSuite {
     object test extends PlayTests
   }
 
-  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "playsingleapi"
+  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "playsingleapi"
 
   def tests: Tests = Tests {
     test("playVersion") {

contrib/playlib/test/src/mill/playlib/PlaySingleModuleTests.scala

@@ -13,7 +13,7 @@ object PlaySingleModuleTests extends TestSuite with PlayTestSuite {
     object test extends PlayTests
   }
 
-  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "playsingle"
+  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "playsingle"
 
   def tests: Tests = Tests {
     test("layout") {

contrib/playlib/test/src/mill/playlib/RouterModuleTests.scala

@@ -22,7 +22,7 @@ object RouterModuleTests extends TestSuite with PlayTestSuite {
 
   }
 
-  val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+  val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
   val resourcePath: os.Path = resourceFolder / "hello-world"
   val invalidResourcePath: os.Path = resourceFolder / "invalid"
   val invalidSubResourcePath: os.Path = resourceFolder / "invalidsub"

contrib/proguard/test/src/mill/contrib/proguard/ProguardTests.scala

@@ -24,7 +24,7 @@ object ProguardTests extends TestSuite {
 
   }
 
-  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "proguard"
+  val testModuleSourcesPath: Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "proguard"
 
   def tests: Tests = Tests {
     test("Proguard module") {

contrib/scalapblib/test/src/mill/contrib/scalapblib/TutorialTests.scala

@@ -55,7 +55,7 @@ object TutorialTests extends TestSuite {
     }
   }
 
-  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
 
   def protobufOutPath(eval: UnitTester): os.Path =
     eval.outPath / "core/compileScalaPB.dest/com/example/tutorial"

contrib/scoverage/test/src/mill/contrib/scoverage/HelloWorldTests.scala

@@ -21,7 +21,7 @@ trait HelloWorldTests extends utest.TestSuite {
   def isScala3: Boolean = testScalaVersion.startsWith("3.")
   def isScov3: Boolean = testScoverageVersion.startsWith("2.")
 
-  val resourcePath = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "hello-world"
+  val resourcePath = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "hello-world"
   val sbtResourcePath = resourcePath / os.up / "hello-world-sbt"
   val unmanagedFile = resourcePath / "unmanaged.xml"
 

contrib/testng/test/src/mill/testng/TestNGTests.scala

@@ -37,7 +37,7 @@ object TestNGTests extends TestSuite {
 
   }
 
-  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "demo"
+  val resourcePath: os.Path = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "demo"
 
   def tests: Tests = Tests {
     test("TestNG") {

contrib/twirllib/test/src/mill/twirllib/HelloWorldTests.scala

@@ -31,7 +31,7 @@ trait HelloWorldTests extends TestSuite {
 
   }
 
-  def resourcePath = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+  def resourcePath = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
   def compileClassfiles: Seq[os.RelPath] = Seq[os.RelPath](
     os.rel / "html/hello.template.scala",
     os.rel / "html/wrapper.template.scala",

example/extending/plugins/7-writing-mill-plugins/myplugin/test/src/mill/testkit/ExampleTests.scala

@@ -6,7 +6,7 @@ object ExampleTests extends TestSuite {
 
   def tests: Tests = Tests {
     test("example") {
-      val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+      val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
       ExampleTester.run(
         clientServerMode = true,
         workspaceSourcePath = resourceFolder / "example-test-project",

example/extending/plugins/7-writing-mill-plugins/myplugin/test/src/mill/testkit/IntegrationTests.scala

@@ -10,7 +10,7 @@ object IntegrationTests extends TestSuite {
 
     test("integration") {
       pprint.log(sys.env("MILL_EXECUTABLE_PATH"))
-      val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+      val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
       val tester = new IntegrationTester(
         clientServerMode = true,
         workspaceSourcePath = resourceFolder / "integration-test-project",

example/extending/plugins/7-writing-mill-plugins/myplugin/test/src/mill/testkit/UnitTests.scala

@@ -10,7 +10,7 @@ object UnitTests extends TestSuite {
         def lineCountResourceFileName = "line-count.txt"
       }
 
-      val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+      val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
       UnitTester(build, resourceFolder / "unit-test-project").scoped { eval =>
 
         // Evaluating tasks by direct reference

example/javalib/module/7-resources/build.mill

@@ -7,7 +7,7 @@ object foo extends JavaModule {
     def otherFiles = Task.Source(millSourcePath / "other-files")
 
     def forkEnv = super.forkEnv() ++ Map(
-      "OTHER_FILES_FOLDER" -> otherFiles().path.toString
+      "OTHER_FILES_DIR" -> otherFiles().path.toString
     )
   }
 }

example/javalib/module/7-resources/foo/test/src/FooTests.java

@@ -26,14 +26,14 @@ public void simple() throws IOException {
     }
     assertEquals("Test Hello World Resource File A", testClasspathResourceText);
 
-    // Use `MILL_TEST_RESOURCE_FOLDER` to read `test-file-b.txt` from filesystem
-    Path testFileResourceDir = Paths.get(System.getenv("MILL_TEST_RESOURCE_FOLDER"));
+    // Use `MILL_TEST_RESOURCE_DIR` to read `test-file-b.txt` from filesystem
+    Path testFileResourceDir = Paths.get(System.getenv("MILL_TEST_RESOURCE_DIR"));
     String testFileResourceText = Files.readString(
         testFileResourceDir.resolve("test-file-b.txt")
     );
     assertEquals("Test Hello World Resource File B", testFileResourceText);
 
-    // Use `MILL_TEST_RESOURCE_FOLDER` to list files available in resource folder
+    // Use `MILL_TEST_RESOURCE_DIR` to list files available in resource folder
     List<Path> actualFiles = new ArrayList<>(Files.list(testFileResourceDir).toList());
     actualFiles.sort(Path::compareTo);
     List<Path> expectedFiles = List.of(
@@ -42,10 +42,10 @@ public void simple() throws IOException {
     );
     assertEquals(expectedFiles, actualFiles);
 
-    // Use the `OTHER_FILES_FOLDER` configured in your build to access the
+    // Use the `OTHER_FILES_DIR` configured in your build to access the
     // files in `foo/test/other-files/`.
     String otherFileText = Files.readString(
-        Paths.get(System.getenv("OTHER_FILES_FOLDER"), "other-file.txt")
+        Paths.get(System.getenv("OTHER_FILES_DIR"), "other-file.txt")
     );
     assertEquals("Other Hello World File", otherFileText);
   }

example/kotlinlib/module/7-resources/build.mill

@@ -10,7 +10,7 @@ object foo extends KotlinModule {
     def otherFiles = T.source(millSourcePath / "other-files")
 
     def forkEnv = super.forkEnv() ++ Map(
-      "OTHER_FILES_FOLDER" -> otherFiles().path.toString
+      "OTHER_FILES_DIR" -> otherFiles().path.toString
     )
 
     def ivyDeps = super.ivyDeps() ++ Agg(

example/kotlinlib/module/7-resources/foo/test/src/FooTests.kt

@@ -24,25 +24,25 @@ class FooTests : FunSpec({
         }
         testClasspathResourceText shouldBe "Test Hello World Resource File A"
 
-        // Use `MILL_TEST_RESOURCE_FOLDER` to read `test-file-b.txt` from filesystem
-        val testFileResourceDir = Paths.get(System.getenv("MILL_TEST_RESOURCE_FOLDER"))
+        // Use `MILL_TEST_RESOURCE_DIR` to read `test-file-b.txt` from filesystem
+        val testFileResourceDir = Paths.get(System.getenv("MILL_TEST_RESOURCE_DIR"))
         val testFileResourceText = Files.readString(
             testFileResourceDir.resolve("test-file-b.txt")
         )
         testFileResourceText shouldBe "Test Hello World Resource File B"
 
-        // Use `MILL_TEST_RESOURCE_FOLDER` to list files available in resource folder
+        // Use `MILL_TEST_RESOURCE_DIR` to list files available in resource folder
         val actualFiles = Files.list(testFileResourceDir).toList().sorted()
         val expectedFiles = listOf(
             testFileResourceDir.resolve("test-file-a.txt"),
             testFileResourceDir.resolve("test-file-b.txt")
         )
         actualFiles shouldBe expectedFiles
 
-        // Use the `OTHER_FILES_FOLDER` configured in your build to access the
+        // Use the `OTHER_FILES_DIR` configured in your build to access the
         // files in `foo/test/other-files/`.
         val otherFileText = Files.readString(
-            Paths.get(System.getenv("OTHER_FILES_FOLDER"), "other-file.txt")
+            Paths.get(System.getenv("OTHER_FILES_DIR"), "other-file.txt")
         )
         otherFileText shouldBe "Other Hello World File"
     }

example/scalalib/module/7-resources/build.mill

@@ -15,7 +15,7 @@ object foo extends ScalaModule {
     def otherFiles = Task.Source(millSourcePath / "other-files")
 
     def forkEnv = super.forkEnv() ++ Map(
-      "OTHER_FILES_FOLDER" -> otherFiles().path.toString
+      "OTHER_FILES_DIR" -> otherFiles().path.toString
     )
   }
 }
@@ -33,17 +33,17 @@ object foo extends ScalaModule {
 // This section discusses how tests can depend on resources locally on disk.
 // Mill provides two ways to do this: via the JVM classpath resources, and via
 // the resource folder which is made available as the environment variable
-// `MILL_TEST_RESOURCE_FOLDER`;
+// `MILL_TEST_RESOURCE_DIR`;
 //
 // * The *classpath resources* are useful when you want to fetch individual files,
 //   and are bundled with the application by the `.assembly` step when constructing
 //   an assembly jar for deployment. But they do not allow you to list folders
 //   or perform other filesystem operations.
 //
-// * The *resource folder*, available via `MILL_TEST_RESOURCE_FOLDER`, gives you
+// * The *resource folder*, available via `MILL_TEST_RESOURCE_DIR`, gives you
 //   access to the folder path of the resources on disk. This is useful in allowing
 //   you to list and otherwise manipulate the filesystem, which you cannot do with
-//   *classpath resources*. However, the `MILL_TEST_RESOURCE_FOLDER` only exists
+//   *classpath resources*. However, the `MILL_TEST_RESOURCE_DIR` only exists
 //   when running tests using Mill, and is not available when executing applications
 //   packaged for deployment via `.assembly`
 //

example/scalalib/module/7-resources/foo/test/src/FooTests.scala

@@ -11,20 +11,20 @@ object FooTests extends TestSuite {
       val testClasspathResourceText = os.read(os.resource / "test-file-a.txt")
       assert(testClasspathResourceText == "Test Hello World Resource File A")
 
-      // Use `MILL_TEST_RESOURCE_FOLDER` to read `test-file-b.txt` from filesystem
-      val testFileResourceDir = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+      // Use `MILL_TEST_RESOURCE_DIR` to read `test-file-b.txt` from filesystem
+      val testFileResourceDir = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
       val testFileResourceText = os.read(testFileResourceDir / "test-file-b.txt")
       assert(testFileResourceText == "Test Hello World Resource File B")
 
-      // Use `MILL_TEST_RESOURCE_FOLDER` to list files available in resource folder
+      // Use `MILL_TEST_RESOURCE_DIR` to list files available in resource folder
       assert(
         os.list(testFileResourceDir).sorted ==
         Seq(testFileResourceDir / "test-file-a.txt", testFileResourceDir / "test-file-b.txt")
       )
 
-      // Use the `OTHER_FILES_FOLDER` configured in your build to access the
+      // Use the `OTHER_FILES_DIR` configured in your build to access the
       // files in `foo/test/other-files/`.
-      val otherFileText = os.read(os.Path(sys.env("OTHER_FILES_FOLDER")) / "other-file.txt")
+      val otherFileText = os.read(os.Path(sys.env("OTHER_FILES_DIR")) / "other-file.txt")
       assert(otherFileText == "Other Hello World File")
     }
   }

example/scalalib/testing/1-test-suite/build.mill

@@ -127,7 +127,7 @@ object bar extends ScalaModule {
 //
 // *Note that Mill runs tests with the working directory set to an empty `sandbox/` folder by default*.
 // Tests can access files from their resource directory via the environment variable
-// `MILL_TEST_RESOURCE_FOLDER` which provides the path to the resource folder, and additional
+// `MILL_TEST_RESOURCE_DIR` which provides the path to the resource folder, and additional
 // paths can be provided to test via `forkEnv`. See
 // xref:javalib/module-config.adoc#_classpath_and_filesystem_resources[Classpath and Filesystem Resources]
 // for more details.

kotlinlib/test/src/mill/kotlinlib/HelloWorldTests.scala

@@ -28,7 +28,7 @@ object HelloWorldTests extends TestSuite {
     object main extends Cross[MainCross](kotlinVersions)
   }
 
-  val resourcePath = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "hello-world-kotlin"
+  val resourcePath = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "hello-world-kotlin"
 
   def testEval() = UnitTester(HelloWorldKotlin, resourcePath)
   def tests: Tests = Tests {

kotlinlib/test/src/mill/kotlinlib/MixedHelloWorldTests.scala

@@ -29,7 +29,7 @@ object MixedHelloWorldTests extends TestSuite {
   }
 
   val resourcePath =
-    os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "mixed-code-hello-world-kotlin"
+    os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "mixed-code-hello-world-kotlin"
 
   def testEval() = UnitTester(MixedHelloWorldKotlin, resourcePath)
   def tests: Tests = Tests {

kotlinlib/test/src/mill/kotlinlib/contrib/kover/KoverModuleTests.scala

@@ -13,7 +13,7 @@ object KoverModuleTests extends TestSuite {
 
   val kotlinVersion = "1.9.24"
 
-  val resourcePath = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "contrib" / "kover"
+  val resourcePath = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "contrib" / "kover"
 
   object module extends TestBaseModule {
 

kotlinlib/test/src/mill/kotlinlib/contrib/ktfmt/KtfmtModuleTests.scala

@@ -15,7 +15,7 @@ object KtfmtModuleTests extends TestSuite {
   def tests: Tests = Tests {
 
     val (before, after) = {
-      val root = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER")) / "contrib" / "ktfmt"
+      val root = os.Path(sys.env("MILL_TEST_RESOURCE_DIR")) / "contrib" / "ktfmt"
       (root / "before", root / "after")
     }
 

main/client/src/mill/main/client/EnvVars.java

@@ -11,7 +11,7 @@ public class EnvVars {
      * in a convenient fashion. If multiple resource folders are provided on the classpath,
      * they are provided as a comma-separated list
      */
-    public static final String MILL_TEST_RESOURCE_FOLDER = "MILL_TEST_RESOURCE_FOLDER";
+    public static final String MILL_TEST_RESOURCE_DIR = "MILL_TEST_RESOURCE_DIR";
 
 
     /**

main/eval/test/src/mill/eval/JavaCompileJarTests.scala

@@ -18,7 +18,7 @@ object JavaCompileJarTests extends TestSuite {
     mill.api.PathRef(ctx.dest)
   }
 
-  val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_FOLDER"))
+  val resourceFolder = os.Path(sys.env("MILL_TEST_RESOURCE_DIR"))
   val javacSrcPath = resourceFolder / "examples/javac"
 
   val tests = Tests {

readme.adoc

@@ -483,7 +483,7 @@ prefixed with `show` and no longer need a separate `graphviz`/`dot` install on M
 
 *** Trivial upgrades that just needed to bump a version: https://github.com/com-lihaoyi/geny/pull/87 , https://github.com/com-lihaoyi/sourcecode/pull/175, https://github.com/com-lihaoyi/fansi/pull/107, https://github.com/com-lihaoyi/PPrint/pull/141, https://github.com/com-lihaoyi/mainargs/pull/159/files, https://github.com/com-lihaoyi/fastparse/pull/319, https://github.com/com-lihaoyi/scalatags/pull/284
 
-*** Less trivial upgrades, needing to make use of `MILL_TEST_RESOURCE_FOLDER` or other explicit path references to be compatible with test sandboxing: https://github.com/com-lihaoyi/requests-scala/pull/174, https://github.com/com-lihaoyi/upickle/pull/627, https://github.com/com-lihaoyi/os-lib/pull/300, https://github.com/com-lihaoyi/scalasql/pull/30
+*** Less trivial upgrades, needing to make use of `MILL_TEST_RESOURCE_DIR` or other explicit path references to be compatible with test sandboxing: https://github.com/com-lihaoyi/requests-scala/pull/174, https://github.com/com-lihaoyi/upickle/pull/627, https://github.com/com-lihaoyi/os-lib/pull/300, https://github.com/com-lihaoyi/scalasql/pull/30
 
 [#0-11-12]
 === 0.11.12 - 2024-08-20