A sbt plugin for creating distributable Scala packages that include dependent jars and launch scripts.
sbt pack
creates a distributable package intarget/pack
folder.- All dependent jars including scala-library.jar are collected in
target/pack/lib
folder. This process is much faster than creating a single-jar as insbt-assembly
orproguard
plugins. - Supporting multi-module projects.
- All dependent jars including scala-library.jar are collected in
sbt pack-archive
generatestar.gz
archive that is ready to distribute.- The archive name is
target/{project name}-{version}.tar.gz
- The archive name is
sbt pack
generates program launch scriptstarget/pack/bin/{program name}
- To run the program no need exists to install Scala, since it is included in the lib folder. Only java command needs to be found in the system.
- It also generates
.bat
launch scripts for Windows users.
- Generates a Makefile for program installation.
- Do
cd target/pack; make install
. Then you can run your program with~/local/bin/{program name}
- Do
- You can install multiple versions of your program in the system.
- The above Makefile script uses a separate folder for each version (e.g.,
~/local/{project name}/{project version}
). - The latest version is linked from
~/local/{project name}/current
- The above Makefile script uses a separate folder for each version (e.g.,
- You can add other resources in
src/pack
folder.- All resources in this folder will be copied to
target/pack
.
- All resources in this folder will be copied to
Add sbt-pack
plugin to your sbt configuration:
project/plugins.sbt
addSbtPlugin("org.xerial.sbt" % "sbt-pack" % "0.5.0") // for sbt-0.13.x or higher
addSbtPlugin("org.xerial.sbt" % "sbt-pack" % "0.2.5") // for sbt-0.12.x (New features will not be supported in this version.)
Repository URL: http://repo1.maven.org/maven2/org/xerial/sbt/
build.sbt
packSettings
// [Optional: Mappings from a program name to the corresponding Main class ]
packMain := Map("hello" -> "myprog.Hello")
Now you can use sbt pack
command in your project.
Import xerial.sbt.Pack.packSettings
into your project settings. Then set packMain
variable, a mapping from the your program names to their corresponding main classes. The main classes must be Scala objects that define def main(args:Array[])
method:
project/Build.scala
import sbt._
import sbt.Keys._
import xerial.sbt.Pack._
object Build extends sbt.Build {
lazy val root = Project(
id = "myprog",
base = file("."),
settings = Defaults.defaultSettings
++ packSettings // This settings add pack and pack-archive commands to sbt
++ Seq(
// [Optional] Specify mappings from program name -> Main class (full package path)
packMain := Map("hello" -> "myprog.Hello"),
// Add custom settings here
// [Optional] JVM options of scripts (program name -> Seq(JVM option, ...))
packJvmOpts := Map("hello" -> Seq("-Xmx512m")),
// [Optional] Extra class paths to look when launching a program
packExtraClasspath := Map("hello" -> Seq("${PROG_HOME}/etc")),
// [Optional] (Generate .bat files for Windows. The default value is true)
packGenerateWindowsBatFile := true
// [Optional] jar file name format in pack/lib folder (Since 0.5.0)
// "default" (project name)-(version).jar
// "full" (organization name).(project name)-(version).jar
// "no-version" (organization name).(project name).jar
// "original" (Preserve original jar file names)
packJarNameConvention := "default"
)
// To publish tar.gz archive to the repository, add the following line (since 0.3.6)
// ++ publishPackArchive
// Before 0.3.6, use below:
// ++ addArtifact(Artifact("myprog", "arch", "tar.gz"), packArchive).settings
)
}
src/main/scala/Hello.scala
package myprog
object Hello {
def main(args:Array[String]) = {
println("Hello World!!")
}
}
Create a package
$ sbt pack
Your program package will be generated in target/pack
folder.
Launch a command
$ target/pack/bin/hello
Hello World!!
Install the command
$ cd target/pack; make install
$ ~/local/bin/hello
Hello World!
Install the command to the system
$ cd target/pack
$ sudo make install PREFIX="/usr/local"
$ /usr/local/bin/hello
Hello World!
Create a tar.gz archive of your Scala program package
$ sbt pack-archive
See also examples folder in the source code. It contains several Scala project examples using sbt-pack.
- scala-min: A minimal Scala project using sbt-pack: https://github.com/xerial/scala-min
- A minimal project to start writing Scala programs.
Creating IntelliJ project:
$ ./sbt "gen-idea sbt-classifiers"
To test sbt-pack plugin, run
$ ./sbt scripted
Run a single test project, e.g., src/sbt-test/sbt-pack/multi-module
:
$ ./sbt "scripted sbt-pack/multi-module"