Deprecate --graalvm-java-version (it's unnecessary with graalvm-community being the default)

Author: Gedochao

modules/cli/src/main/scala/scala/cli/commands/package0/Package.scala

@@ -67,7 +67,7 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
   override def sharedOptions(options: PackageOptions): Option[SharedOptions] = Some(options.shared)
   override def scalaSpecificationLevel = SpecificationLevel.RESTRICTED
   override def buildOptions(options: PackageOptions): Option[BuildOptions] =
-    Some(options.baseBuildOptions.orExit(options.shared.logger))
+    Some(options.baseBuildOptions(options.shared.logger).orExit(options.shared.logger))
   override def runCommand(options: PackageOptions, args: RemainingArgs, logger: Logger): Unit = {
     val inputs = options.shared.inputs(args.remaining).orExit(logger)
     CurrentParams.workspaceOpt = Some(inputs.workspace)
@@ -166,7 +166,8 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
   }
 
   def finalBuildOptions(options: PackageOptions): BuildOptions = {
-    val initialOptions = options.finalBuildOptions.orExit(options.shared.logger)
+    val initialOptions =
+      options.finalBuildOptions(options.shared.logger).orExit(options.shared.logger)
     val finalBuildOptions = initialOptions.copy(scalaOptions =
       initialOptions.scalaOptions.copy(defaultScalaVersion = Some(defaultScalaVersion))
     )

modules/cli/src/main/scala/scala/cli/commands/package0/PackageOptions.scala

@@ -9,7 +9,7 @@ import scala.build.compiler.{ScalaCompilerMaker, SimpleScalaCompilerMaker}
 import scala.build.errors.{BuildException, CompositeBuildException, ModuleFormatError}
 import scala.build.options.*
 import scala.build.options.packaging.*
-import scala.build.{BuildThreads, Positioned}
+import scala.build.{BuildThreads, Logger, Positioned}
 import scala.cli.commands.package0.PackageOptions
 import scala.cli.commands.shared.*
 import scala.cli.commands.tags
@@ -177,7 +177,7 @@ final case class PackageOptions(
       .sequence
       .left.map(CompositeBuildException(_))
 
-  def baseBuildOptions: Either[BuildException, BuildOptions] = either {
+  def baseBuildOptions(logger: Logger): Either[BuildException, BuildOptions] = either {
     val baseOptions = value(shared.buildOptions())
     baseOptions.copy(
       mainClass = mainClass.mainClass.filter(_.nonEmpty),
@@ -222,13 +222,25 @@ final case class PackageOptions(
             cmd = packager.dockerCmd,
             isDockerEnabled = Some(docker)
           ),
-          nativeImageOptions = NativeImageOptions(
-            graalvmJvmId = packager.graalvmJvmId.map(_.trim).filter(_.nonEmpty),
-            graalvmJavaVersion = packager.graalvmJavaVersion.filter(_ > 0),
-            graalvmVersion = packager.graalvmVersion.map(_.trim).filter(_.nonEmpty),
-            graalvmArgs =
-              packager.graalvmArgs.map(_.trim).filter(_.nonEmpty).map(Positioned.commandLine)
-          ),
+          nativeImageOptions = {
+            val graalVmVersion     = packager.graalvmVersion.map(_.trim).filter(_.nonEmpty)
+            val graalVmJavaVersion = packager.graalvmJvmId.map(_.trim)
+            for {
+              vmVersion   <- graalVmVersion
+              javaVersion <- graalVmJavaVersion
+              if !vmVersion.startsWith(javaVersion)
+            } logger.message(
+              s"""GraalVM Java major version ($javaVersion) does not match GraalVM version ($vmVersion).
+                 |GraalVM version should start with the Java major version to be used.""".stripMargin
+            )
+            NativeImageOptions(
+              graalvmJvmId = packager.graalvmJvmId.map(_.trim).filter(_.nonEmpty),
+              graalvmJavaVersion = packager.graalvmJavaVersion.filter(_ > 0),
+              graalvmVersion = graalVmVersion,
+              graalvmArgs =
+                packager.graalvmArgs.map(_.trim).filter(_.nonEmpty).map(Positioned.commandLine)
+            )
+          },
           useDefaultScaladocOptions = defaultScaladocOptions
         ),
         addRunnerDependencyOpt = Some(false)
@@ -241,8 +253,8 @@ final case class PackageOptions(
     )
   }
 
-  def finalBuildOptions: Either[BuildException, BuildOptions] = either {
-    val baseOptions = value(baseBuildOptions)
+  def finalBuildOptions(logger: Logger): Either[BuildException, BuildOptions] = either {
+    val baseOptions = value(baseBuildOptions(logger))
     baseOptions.copy(
       notForBloopOptions = baseOptions.notForBloopOptions.copy(
         packageOptions = baseOptions.notForBloopOptions.packageOptions.copy(

modules/cli/src/main/scala/scala/cli/commands/package0/PackagerOptions.scala

@@ -144,6 +144,7 @@ final case class PackagerOptions(
   @ValueDescription("java-major-version")
   @Tag(tags.restricted)
   @Tag(tags.inShortHelp)
+  @Tag(tags.deprecated("graalvmJavaVersion"))
     graalvmJavaVersion: Option[Int] = None,
   @Group(HelpGroup.NativeImage.toString)
   @HelpMessage(s"GraalVM version to use to build GraalVM native images (${Constants.defaultGraalVMVersion} by default)")

modules/options/src/main/scala/scala/build/options/packaging/NativeImageOptions.scala

@@ -12,9 +12,8 @@ final case class NativeImageOptions(
 ) {
   lazy val jvmId: String =
     graalvmJvmId.getOrElse {
-      val javaVersion = graalvmJavaVersion.getOrElse(Constants.defaultGraalVMJavaVersion)
-      val version     = graalvmVersion.getOrElse(Constants.defaultGraalVMVersion)
-      s"graalvm-java$javaVersion:$version"
+      val version = graalvmVersion.getOrElse(Constants.defaultGraalVMVersion)
+      s"graalvm-community:$version"
     }
 }
 

website/docs/commands/package.md

@@ -286,8 +286,7 @@ Note that Scala CLI automatically downloads and unpacks a GraalVM distribution
 using the [JVM management capabilities of coursier](https://get-coursier.io/docs/cli-java).
 
 Several options can be passed to adjust the GraalVM version used by Scala CLI:
-- `--graalvm-jvm-id` accepts a JVM identifier, such as `graalvm-java17:22.0.0` or `graalvm-java17:21` (short versions accepted).
-- `--graalvm-java-version` makes it possible to specify only a target Java version, such as `11` or `17` (note that only specific Java versions may be supported by the default GraalVM version that Scala CLI picks)
+- `--graalvm-jvm-id` accepts a JVM identifier, such as `graalvm-community:17.0.9` or `graalvm-java17:23.0.2`.
 - `--graalvm-version` makes it possible to specify only a GraalVM version, such as `22.0.0` or `21` (short versions accepted)
 - `--graalvm-args` makes it possible to pass args to GraalVM version
 

website/docs/reference/cli-options.md

@@ -978,7 +978,7 @@ GraalVM Java major version to use to build GraalVM native images (17 by default)
 
 ### `--graalvm-version`
 
-GraalVM version to use to build GraalVM native images (22.3.1 by default)
+GraalVM version to use to build GraalVM native images (17.0.9 by default)
 
 ### `--graalvm-jvm-id`