From 5dbe1916df3db951313e07134d8df7f4197bb598 Mon Sep 17 00:00:00 2001 From: Hamza REMMAL Date: Mon, 1 Jul 2024 14:44:50 +0200 Subject: [PATCH] Use sbt-native-packager instead of sbt-pack --- .github/workflows/build-msi.yml | 28 ++++++ pkgs/msi/README.md | 1 + project/Build.scala | 73 ++++++++------ project/DistributionPlugin.scala | 50 ++++++++++ project/RepublishPlugin.scala | 161 +++++++++++++------------------ project/plugins.sbt | 4 +- 6 files changed, 195 insertions(+), 122 deletions(-) create mode 100644 .github/workflows/build-msi.yml create mode 100644 pkgs/msi/README.md create mode 100644 project/DistributionPlugin.scala diff --git a/.github/workflows/build-msi.yml b/.github/workflows/build-msi.yml new file mode 100644 index 000000000000..b1a62d464881 --- /dev/null +++ b/.github/workflows/build-msi.yml @@ -0,0 +1,28 @@ + +name: Build the MSI Package + +on: + pull_request: + +jobs: + build: + runs-on: windows-latest + env: + RELEASEBUILD: yes + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - uses: actions/setup-java@v3 + with: + distribution: 'adopt' + java-version: '8' + cache: 'sbt' + - name: Build MSI package + run: | + sbt 'dist-win-x86_64/Windows/packageBin' + - name: Upload MSI Artifact + uses: actions/upload-artifact@v4 + with: + name: scala.msi + path: ./dist/win-x86_64/target/windows/scala.msi diff --git a/pkgs/msi/README.md b/pkgs/msi/README.md new file mode 100644 index 000000000000..1be4272023eb --- /dev/null +++ b/pkgs/msi/README.md @@ -0,0 +1 @@ +error CNDL0108 : The Product/@Version attribute's value, '3.5.1-RC1', is not a valid version. Legal version values should look like 'x.x.x.x' where x is an integer from 0 to 65534 \ No newline at end of file diff --git a/project/Build.scala b/project/Build.scala index 32a4577fe34c..8e808857e875 100644 --- a/project/Build.scala +++ b/project/Build.scala @@ -1,27 +1,31 @@ import java.io.File import java.nio.file._ - import Process._ import Modes._ import ScaladocGeneration._ import com.jsuereth.sbtpgp.PgpKeys -import sbt.Keys._ -import sbt._ +import sbt.Keys.* +import sbt.* import complete.DefaultParsers._ import pl.project13.scala.sbt.JmhPlugin import pl.project13.scala.sbt.JmhPlugin.JmhKeys.Jmh +import com.typesafe.sbt.packager.Keys._ +import com.typesafe.sbt.packager.MappingsHelper.directory +import com.typesafe.sbt.packager.universal.UniversalPlugin +import com.typesafe.sbt.packager.universal.UniversalPlugin.autoImport.Universal +import com.typesafe.sbt.packager.windows.WindowsPlugin +import com.typesafe.sbt.packager.windows.WindowsPlugin.autoImport.Windows import sbt.Package.ManifestAttributes import sbt.PublishBinPlugin.autoImport._ import dotty.tools.sbtplugin.RepublishPlugin import dotty.tools.sbtplugin.RepublishPlugin.autoImport._ import sbt.plugins.SbtPlugin import sbt.ScriptedPlugin.autoImport._ -import xerial.sbt.pack.PackPlugin -import xerial.sbt.pack.PackPlugin.autoImport._ import xerial.sbt.Sonatype.autoImport._ import com.typesafe.tools.mima.plugin.MimaPlugin.autoImport._ import org.scalajs.sbtplugin.ScalaJSPlugin import org.scalajs.sbtplugin.ScalaJSPlugin.autoImport._ + import sbtbuildinfo.BuildInfoPlugin import sbtbuildinfo.BuildInfoPlugin.autoImport._ import sbttastymima.TastyMiMaPlugin @@ -88,7 +92,7 @@ object Build { val referenceVersion = "3.4.2-RC1" - val baseVersion = "3.5.1-RC1" + val baseVersion = "3.5.1" // LTS or Next val versionLine = "Next" @@ -2124,25 +2128,27 @@ object Build { ) lazy val commonDistSettings = Seq( - packMain := Map(), publishArtifact := false, - packGenerateMakefile := false, republishRepo := target.value / "republish", - packResourceDir += (republishRepo.value / "bin" -> "bin"), - packResourceDir += (republishRepo.value / "maven2" -> "maven2"), - packResourceDir += (republishRepo.value / "etc" -> "etc"), - republishCommandLibs += - ("scala" -> List("scala3-interfaces", "scala3-compiler", "scala3-library", "tasty-core")), - republishCommandLibs += - ("with_compiler" -> List("scala3-staging", "scala3-tasty-inspector", "^!scala3-interfaces", "^!scala3-compiler", "^!scala3-library", "^!tasty-core")), - republishCommandLibs += - ("scaladoc" -> List("scala3-interfaces", "scala3-compiler", "scala3-library", "tasty-core", "scala3-tasty-inspector", "scaladoc")), - Compile / pack := republishPack.value, + Universal / packageName := packageName.value, + // ======== + Universal / stage := (Universal / stage).dependsOn(republish).value, + Universal / packageBin := (Universal / packageBin).dependsOn(republish).value, + Universal / packageZipTarball := (Universal / packageZipTarball).dependsOn(republish).value, + // ======== + Universal / mappings ++= directory(republishRepo.value / "bin"), + Universal / mappings ++= directory(republishRepo.value / "maven2"), + Universal / mappings ++= directory(republishRepo.value / "etc"), + Universal / mappings += (republishRepo.value / "VERSION") -> "VERSION", + // ======== + republishCommandLibs += ("scala" -> List("scala3-interfaces", "scala3-compiler", "scala3-library", "tasty-core")), + republishCommandLibs += ("with_compiler" -> List("scala3-staging", "scala3-tasty-inspector", "^!scala3-interfaces", "^!scala3-compiler", "^!scala3-library", "^!tasty-core")), + republishCommandLibs += ("scaladoc" -> List("scala3-interfaces", "scala3-compiler", "scala3-library", "tasty-core", "scala3-tasty-inspector", "scaladoc")), ) lazy val dist = project.asDist(Bootstrapped) + .settings(packageName := "scala3-" + dottyVersion) .settings( - packArchiveName := "scala3-" + dottyVersion, republishBinDir := baseDirectory.value / "bin", republishCoursier += ("coursier.jar" -> s"https://github.com/coursier/coursier/releases/download/v$coursierJarVersion/coursier.jar"), @@ -2151,9 +2157,9 @@ object Build { ) lazy val `dist-mac-x86_64` = project.in(file("dist/mac-x86_64")).asDist(Bootstrapped) + .settings(packageName := (dist / packageName).value + "-x86_64-apple-darwin") .settings( republishBinDir := (dist / republishBinDir).value, - packArchiveName := (dist / packArchiveName).value + "-x86_64-apple-darwin", republishBinOverrides += (dist / baseDirectory).value / "bin-native-overrides", republishFetchCoursier := (dist / republishFetchCoursier).value, republishLaunchers += @@ -2161,9 +2167,9 @@ object Build { ) lazy val `dist-mac-aarch64` = project.in(file("dist/mac-aarch64")).asDist(Bootstrapped) + .settings(packageName := (dist / packageName).value + "-aarch64-apple-darwin") .settings( republishBinDir := (dist / republishBinDir).value, - packArchiveName := (dist / packArchiveName).value + "-aarch64-apple-darwin", republishBinOverrides += (dist / baseDirectory).value / "bin-native-overrides", republishFetchCoursier := (dist / republishFetchCoursier).value, republishLaunchers += @@ -2171,21 +2177,35 @@ object Build { ) lazy val `dist-win-x86_64` = project.in(file("dist/win-x86_64")).asDist(Bootstrapped) + .enablePlugins(WindowsPlugin) // TO GENERATE THE `.msi` installer + .settings(packageName := (dist / packageName).value + "-x86_64-pc-win32") .settings( republishBinDir := (dist / republishBinDir).value, - packArchiveName := (dist / packArchiveName).value + "-x86_64-pc-win32", republishBinOverrides += (dist / baseDirectory).value / "bin-native-overrides", republishFetchCoursier := (dist / republishFetchCoursier).value, republishExtraProps += ("cli_version" -> scalaCliLauncherVersion), - mappings += (republishRepo.value / "EXTRA_PROPERTIES" -> "EXTRA_PROPERTIES"), republishLaunchers += ("scala-cli.exe" -> s"zip+https://github.com/VirtusLab/scala-cli/releases/download/v$scalaCliLauncherVersionWindows/scala-cli-x86_64-pc-win32.zip!/scala-cli.exe") ) + .settings( + Universal / mappings += (republishRepo.value / "EXTRA_PROPERTIES" -> "EXTRA_PROPERTIES"), + ) + .settings( + Windows / name := "scala", + Windows / mappings := (Universal / mappings).value, + Windows / packageBin := (Windows / packageBin).dependsOn(republish).value, + Windows / wixFiles := (Windows / wixFiles).dependsOn(republish).value, + maintainer := "Hamza Remmal ", + packageSummary := s"Scala $dottyVersion", + packageDescription := """Installer for the Scala Programming Language""", + wixProductId := "74ED19C3-74FE-4ABA-AF30-55A06B6322A9", + wixProductUpgradeId := "3E5A1A82-CA67-4353-94FE-5BDD400AF66B" + ) lazy val `dist-linux-x86_64` = project.in(file("dist/linux-x86_64")).asDist(Bootstrapped) + .settings(packageName := (dist / packageName).value + "-x86_64-pc-linux") .settings( republishBinDir := (dist / republishBinDir).value, - packArchiveName := (dist / packArchiveName).value + "-x86_64-pc-linux", republishBinOverrides += (dist / baseDirectory).value / "bin-native-overrides", republishFetchCoursier := (dist / republishFetchCoursier).value, republishLaunchers += @@ -2193,9 +2213,9 @@ object Build { ) lazy val `dist-linux-aarch64` = project.in(file("dist/linux-aarch64")).asDist(Bootstrapped) + .settings(packageName := (dist / packageName).value + "-aarch64-pc-linux") .settings( republishBinDir := (dist / republishBinDir).value, - packArchiveName := (dist / packArchiveName).value + "-aarch64-pc-linux", republishBinOverrides += (dist / baseDirectory).value / "bin-native-overrides", republishFetchCoursier := (dist / republishFetchCoursier).value, republishLaunchers += @@ -2333,7 +2353,7 @@ object Build { settings(scala3PresentationCompilerBuildInfo) def asDist(implicit mode: Mode): Project = project. - enablePlugins(PackPlugin, RepublishPlugin). + enablePlugins(UniversalPlugin, RepublishPlugin). withCommonSettings. settings(commonDistSettings). dependsOn( @@ -2429,7 +2449,6 @@ object ScaladocConfigs { } lazy val DefaultGenerationConfig = Def.task { - def distLocation = (dist / Compile / pack).value DefaultGenerationSettings.value } diff --git a/project/DistributionPlugin.scala b/project/DistributionPlugin.scala new file mode 100644 index 000000000000..473ecd8378af --- /dev/null +++ b/project/DistributionPlugin.scala @@ -0,0 +1,50 @@ +import com.typesafe.sbt.packager.Keys.stage +import com.typesafe.sbt.packager.universal.UniversalPlugin +import com.typesafe.sbt.packager.universal.UniversalPlugin.autoImport.Universal +import sbt.* + +/** + * @author Hamza REMMAL (https://github.com/hamzaremmal/) + */ +object DistributionPlugin extends AutoPlugin { + + override def trigger = allRequirements + + override def requires = + super.requires && UniversalPlugin // Require the Universal Plugin to + + object autoImport { + val `universal_project` = settingKey[Project]("???") + val `linux-aarch64_project` = settingKey[Project]("???") + val `linux-x86_64_project` = settingKey[Project]("???") + val `mac-aarch64_project` = settingKey[Project]("???") + val `win-x86_64_project` = settingKey[Project]("???") + + + // ========================== TASKS TO GENERATE THE FOLDER PACKAGE ============================ + val `pack-universal` = + taskKey[File]("Generate the package with the universal binaries (folder)") + val `pack_linux-aarch64` = + taskKey[File]("Generate the package with the linux-aarch64 binaries (folder)") + val `pack_linux-x86_64` = + taskKey[File]("Generate the package with the linux-x86_64 binaries (folder)") + val `pack_mac-aarch64` = + taskKey[File]("Generate the package with the mac-aarch64 binaries (folder)") + val `pack_mac-x86_64` = + taskKey[File]("Generate the package with the mac-x86_64 binaries (folder)") + val `pack_win-x86_64` = + taskKey[File]("Generate the package with the linux-x86_64 binaries (folder)") + } + + import autoImport.* + + override def projectSettings = Def.settings( + `pack-universal` := (`universal_project` / Universal./(stage)).value , + `pack_linux-aarch64` := ???, + `pack_linux-x86_64` := ???, + `pack_mac-aarch64` := ???, + `pack_mac-x86_64` := ???, + `pack_win-x86_64` := ??? + ) + +} diff --git a/project/RepublishPlugin.scala b/project/RepublishPlugin.scala index e4bf40545a6b..f20576948aae 100644 --- a/project/RepublishPlugin.scala +++ b/project/RepublishPlugin.scala @@ -1,22 +1,18 @@ package dotty.tools.sbtplugin -import sbt._ -import xerial.sbt.pack.PackPlugin -import xerial.sbt.pack.PackPlugin.autoImport.{packResourceDir, packDir} -import sbt.Keys._ +import com.typesafe.sbt.packager.universal.UniversalPlugin +import sbt.* +import sbt.Keys.* import sbt.AutoPlugin import sbt.PublishBinPlugin -import sbt.PublishBinPlugin.autoImport._ +import sbt.PublishBinPlugin.autoImport.* import sbt.io.Using -import sbt.util.CacheImplicits._ +import sbt.util.CacheImplicits.* -import scala.collection.mutable import java.nio.file.Files - import java.nio.file.attribute.PosixFilePermission -import java.nio.file.{Files, Path} - -import scala.jdk.CollectionConverters._ +import java.nio.file.Path +import scala.jdk.CollectionConverters.* /** This local plugin provides ways of publishing a project classpath and library dependencies to * .a local repository */ @@ -53,7 +49,7 @@ object RepublishPlugin extends AutoPlugin { } override def trigger = allRequirements - override def requires = super.requires && PublishBinPlugin && PackPlugin + override def requires = super.requires && PublishBinPlugin && UniversalPlugin object autoImport { val republishProjectRefs = taskKey[Seq[ProjectRef]]("fetch the classpath deps from the project.") @@ -338,6 +334,65 @@ object RepublishPlugin extends AutoPlugin { allLaunchers.toSet } + private def generateVersionFile() = Def.task[Unit] { + import scala.util.Try + import java.time.format.DateTimeFormatterBuilder + import java.time.format.SignStyle + import java.time.temporal.ChronoField.* + import java.time.ZoneId + import java.time.Instant + import java.time.ZonedDateTime + import java.time.ZonedDateTime + import java.util.Locale + import java.util.Date + + val base: File = new File(".") // Using the working directory as base for readability + val s = streams.value + val log = s.log + val progVersion = version.value + val distDir = republishRepo.value + + def write(path: String, content: String) { + val p = distDir / path + IO.write(p, content) + } + + val humanReadableTimestampFormatter = new DateTimeFormatterBuilder() + .parseCaseInsensitive() + .appendValue(YEAR, 4, 10, SignStyle.EXCEEDS_PAD) + .appendLiteral('-') + .appendValue(MONTH_OF_YEAR, 2) + .appendLiteral('-') + .appendValue(DAY_OF_MONTH, 2) + .appendLiteral(' ') + .appendValue(HOUR_OF_DAY, 2) + .appendLiteral(':') + .appendValue(MINUTE_OF_HOUR, 2) + .appendLiteral(':') + .appendValue(SECOND_OF_MINUTE, 2) + .appendOffset("+HHMM", "Z") + .toFormatter(Locale.US) + + // Retrieve build time + val systemZone = ZoneId.systemDefault().normalized() + val timestamp = ZonedDateTime.ofInstant(Instant.ofEpochMilli(new Date().getTime), systemZone) + val buildTime = humanReadableTimestampFormatter.format(timestamp) + + // Check the current Git revision + val gitRevision: String = Try { + if ((base / ".git").exists()) { + log.info("[republish] Checking the git revision of the current project") + sys.process.Process("git rev-parse HEAD").!! + } else { + "unknown" + } + }.getOrElse("unknown").trim + + + // Output the version number and Git revision + write("VERSION", s"version:=${progVersion}\nrevision:=${gitRevision}\nbuildTime:=${buildTime}\n") + } + override val projectSettings: Seq[Def.Setting[_]] = Def.settings( republishCoursierDir := republishRepo.value / "coursier", republishLaunchers := Seq.empty, @@ -462,88 +517,8 @@ object RepublishPlugin extends AutoPlugin { val artifacts = republishClasspath.value val launchers = republishFetchLaunchers.value val extraProps = republishWriteExtraProps.value + val versionFile = generateVersionFile().value cacheDir }, - republishPack := { - val cacheDir = republish.value - val s = streams.value - val log = s.log - val distDir = target.value / packDir.value - val progVersion = version.value - - IO.createDirectory(distDir) - for ((path, dir) <- packResourceDir.value) { - val target = distDir / dir - IO.copyDirectory(path, target) - } - - locally { - // everything in this block is copied from sbt-pack plugin - import scala.util.Try - import java.time.format.DateTimeFormatterBuilder - import java.time.format.SignStyle - import java.time.temporal.ChronoField.* - import java.time.ZoneId - import java.time.Instant - import java.time.ZonedDateTime - import java.time.ZonedDateTime - import java.util.Locale - import java.util.Date - val base: File = new File(".") // Using the working directory as base for readability - - // Copy explicitly added dependencies - val mapped: Seq[(File, String)] = mappings.value - log.info("[republish] Copying explicit dependencies:") - val explicitDepsJars = for ((file, path) <- mapped) yield { - log.info(file.getPath) - val dest = distDir / path - IO.copyFile(file, dest, true) - dest - } - - def write(path: String, content: String) { - val p = distDir / path - IO.write(p, content) - } - - val humanReadableTimestampFormatter = new DateTimeFormatterBuilder() - .parseCaseInsensitive() - .appendValue(YEAR, 4, 10, SignStyle.EXCEEDS_PAD) - .appendLiteral('-') - .appendValue(MONTH_OF_YEAR, 2) - .appendLiteral('-') - .appendValue(DAY_OF_MONTH, 2) - .appendLiteral(' ') - .appendValue(HOUR_OF_DAY, 2) - .appendLiteral(':') - .appendValue(MINUTE_OF_HOUR, 2) - .appendLiteral(':') - .appendValue(SECOND_OF_MINUTE, 2) - .appendOffset("+HHMM", "Z") - .toFormatter(Locale.US) - - // Retrieve build time - val systemZone = ZoneId.systemDefault().normalized() - val timestamp = ZonedDateTime.ofInstant(Instant.ofEpochMilli(new Date().getTime), systemZone) - val buildTime = humanReadableTimestampFormatter.format(timestamp) - - // Check the current Git revision - val gitRevision: String = Try { - if ((base / ".git").exists()) { - log.info("[republish] Checking the git revision of the current project") - sys.process.Process("git rev-parse HEAD").!! - } else { - "unknown" - } - }.getOrElse("unknown").trim - - - // Output the version number and Git revision - write("VERSION", s"version:=${progVersion}\nrevision:=${gitRevision}\nbuildTime:=${buildTime}\n") - } - - - distDir - } ) } diff --git a/project/plugins.sbt b/project/plugins.sbt index 59e58007a4a0..96f767726315 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -12,8 +12,6 @@ addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "3.9.21") addSbtPlugin("com.github.sbt" % "sbt-pgp" % "2.2.1") -addSbtPlugin("org.xerial.sbt" % "sbt-pack" % "0.17") - addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.4.5") addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.11.0") @@ -21,3 +19,5 @@ addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.11.0") addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "1.1.2") addSbtPlugin("ch.epfl.scala" % "sbt-tasty-mima" % "1.0.0") + +addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.7.6")