updated site

sbt · Jan 9, 2016 · 78611a3 · 78611a3
1 parent 34c6e22
commit 78611a3
Show file tree

Hide file tree

Showing 39 changed files with 308 additions and 171 deletions.
diff --git a/_sources/archetypes/index.txt b/_sources/archetypes/index.txt
@@ -88,7 +88,7 @@ Java Server
 
 This archetype is designed for Java applications that are intended to run as
 servers or services.  This archetype includes wiring an application to start
-immediately upon startup. To activate this archetype replace ``enablePlugins(JavaAppPackaging)`` with ``enablePlugins(JavaServerAppPackaging)``.
+immediately upon startup. To activate this archetype replace ``enablePlugins(JavaAppPackaging)`` with ``enablePlugis(JavaServerAppPackaging)``.
 
 
 The Java Server archetype has a similar installation layout as the java

diff --git a/_sources/formats/debian.txt b/_sources/formats/debian.txt
@@ -57,33 +57,31 @@ you have these settings in your build:
     packageDescription := """A fun package description of our software,
       with multiple lines."""
 
-1.0 or higher
-~~~~~~~~~~~~~
 
 Enable the debian plugin to activate the native package implementation.
 
 .. code-block:: scala
 
   enablePlugins(DebianPlugin)
 
+Java based packaging
+~~~~~~~~~~~~~~~~~~~~
+
 If you want to use the java based implementation, enable the following plugin.
 
 .. code-block:: scala
 
   enablePlugins(JDebPackaging)
-
-0.8 or lower
-~~~~~~~~~~~~
-
-For this versions debian packaging is automatically activated.
-See the :doc:`Getting Started </gettingstarted>` page for information
-on how to enable sbt native packager.
-
-If you want to enable `jdeb` packaging add the following to your `build.sbt`
+
+and this to your ``plugins.sbt``
 
 .. code-block:: scala
 
-    packageBin in Debian <<= debianJDebPackaging in Debian
+  libraryDependencies += "org.vafer" % "jdeb" % "1.3" artifacts (Artifact("jdeb", "jar", "jar"))
+
+JDeb is a provided dependency so you have to add it on your own. It brings a lot of dependencies
+that could slow your build times. This is the reason the dependency is marked as provided.
+
 
 
 Configurations

diff --git a/_sources/formats/docker.txt b/_sources/formats/docker.txt
@@ -34,19 +34,30 @@ Build
 Required Settings
 ~~~~~~~~~~~~~~~~~
 
-1.0 or higher
-~~~~~~~~~~~~~
-
 .. code-block:: scala
 
   enablePlugins(DockerPlugin)
+
+Spotify java based docker client
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can also use the java-based spotify Docker client. Add this to your ``build.sbt``
+
+
+.. code-block:: scala
+
+  enablePlugins(DockerSpotifyClientPlugin)
+
+
+and this to your ``plugins.sbt``
+
+.. code-block:: scala
 
-0.8.x
-~~~~~
+  libraryDependencies += "com.spotify" % "docker-client" % "3.2.1"
 
-For this versions docker packaging is automatically activated.
-See the :doc:`Getting Started </gettingstarted>` page for information
-on how to enable sbt native packager.
+The Docker-spotify client is a provided dependency so you have to add it on your own. 
+It brings a lot of dependenciesthat could slow your build times. This is the reason 
+the dependency is marked as provided.
 
 Configuration
 -------------

diff --git a/_sources/topics/custom.txt b/_sources/topics/custom.txt
@@ -13,7 +13,7 @@ SBT Assembly
     | Create a fat-jar with sbt-assembly in order to deliver a single,
     | self-containing jar as a package instead of the default lib/ structure
 
-First add the sbt-assembly plugin to your `plugins.sbt` file.
+First add the sbt-assembly plugin to your ``plugins.sbt`` file.
 
 .. code-block:: scala
 
@@ -53,6 +53,64 @@ contains the assembled jar. This is what the final ``build.sbt`` should contain:
 
     // the bash scripts classpath only needs the fat jar
     scriptClasspath := Seq( (jarName in assembly).value )
+
+
+Proguard
+-------------------
+
+    **Main Goal**
+
+    | Create a package that contains a single fat-jar that has been shrunken / optimized / obfuscated with `proguard <http://proguard.sourceforge.net/>`_.
+
+First add the `sbt-proguard <https://github.com/sbt/sbt-proguard>`_ plugin to
+the ``plugins.sbt`` file:
+
+.. code-block:: scala
+
+    addSbtPlugin("com.typesafe.sbt" % "sbt-proguard" % "0.2.2")
+
+Then configure the proguard options in ``build.sbt``:
+
+.. code-block:: scala
+
+    import com.typesafe.sbt.SbtProguard.ProguardKeys
+
+    // initialize the proguard settings
+    proguardSettings
+
+    // to configure proguard for scala, see
+    // http://proguard.sourceforge.net/manual/examples.html#scala
+    ProguardKeys.options in Proguard ++= Seq(
+        "--dontwarn scala.**",
+        "--dontwarn ch.qos.**"
+        // ...
+    )
+
+    // specify the entry point for a standalone app
+    ProguardKeys.options in Proguard += ProguardOptions.keepMain("com.example.Main")
+
+    // Java 8 requires a newer version of proguard than sbt-proguard's default
+    ProguardKeys.proguardVersion in Proguard := "5.2.1"
+
+    // filter out jar files from the list of generated files, while
+    // keeping non-jar output such as generated launch scripts
+    mappings in Universal := (mappings in Universal).value.
+      filter {
+        case (file, name) =>  ! name.endsWith(".jar")
+      }
+
+    // ... and then append the jar file emitted from the proguard task to
+    // the file list
+    mappings in Universal ++= (ProguardKeys.proguard in Proguard).
+        value.map(jar => jar -> ("lib/" +jar.getName))
+
+    // point the classpath to the output from the proguard task
+    scriptClasspath := (ProguardKeys.proguard in Proguard).value.map(jar => jar.getName)
+
+Now when you package your project using a command such as ``sbt universal:package-zip-tarball``, 
+it will include fat jar that has been created by proguard rather than the normal 
+output in ``/lib``.
+
 
 Multi Module Builds
 -------------------

diff --git a/archetypes/akka_app/index.html b/archetypes/akka_app/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Akka Microkernel &mdash; sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation</title>
+    <title>Akka Microkernel &mdash; sbt-native-packager 1.1.0-SNAPSHOT documentation</title>
 
     <link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce',
+        VERSION:     '1.1.0-SNAPSHOT',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../../_static/js/jquery-fix.js"></script>
     <script type="text/javascript" src="../../_static/bootstrap-3.2.0/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../../_static/bootstrap-sphinx.js"></script>
-    <link rel="top" title="sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation" href="../../index.html" />
+    <link rel="top" title="sbt-native-packager 1.1.0-SNAPSHOT documentation" href="../../index.html" />
     <link rel="up" title="Project Archetypes" href="../index.html" />
     <link rel="next" title="Archetype Cheatsheet" href="../cheatsheet.html" />
     <link rel="prev" title="Customize Java Server Applications" href="../java_server/customize.html" />
@@ -51,7 +51,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           sbt-native-packager</a>
-        <span class="navbar-text navbar-version pull-left"><b>1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>1.1.0-SNAPSHOT</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/archetypes/cheatsheet.html b/archetypes/cheatsheet.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Archetype Cheatsheet &mdash; sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation</title>
+    <title>Archetype Cheatsheet &mdash; sbt-native-packager 1.1.0-SNAPSHOT documentation</title>
 
     <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce',
+        VERSION:     '1.1.0-SNAPSHOT',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-3.2.0/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
-    <link rel="top" title="sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation" href="../index.html" />
+    <link rel="top" title="sbt-native-packager 1.1.0-SNAPSHOT documentation" href="../index.html" />
     <link rel="up" title="Project Archetypes" href="index.html" />
     <link rel="next" title="Packaging Formats" href="../formats/index.html" />
     <link rel="prev" title="Akka Microkernel" href="akka_app/index.html" />
@@ -51,7 +51,7 @@
         </button>
         <a class="navbar-brand" href="../index.html">
           sbt-native-packager</a>
-        <span class="navbar-text navbar-version pull-left"><b>1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>1.1.0-SNAPSHOT</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/archetypes/index.html b/archetypes/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Project Archetypes &mdash; sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation</title>
+    <title>Project Archetypes &mdash; sbt-native-packager 1.1.0-SNAPSHOT documentation</title>
 
     <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce',
+        VERSION:     '1.1.0-SNAPSHOT',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-3.2.0/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
-    <link rel="top" title="sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation" href="../index.html" />
+    <link rel="top" title="sbt-native-packager 1.1.0-SNAPSHOT documentation" href="../index.html" />
     <link rel="next" title="Java Application Archetype" href="java_app/index.html" />
     <link rel="prev" title="Contributing Documentation" href="../topics/documentation.html" />
 <meta charset='utf-8'>
@@ -50,7 +50,7 @@
         </button>
         <a class="navbar-brand" href="../index.html">
           sbt-native-packager</a>
-        <span class="navbar-text navbar-version pull-left"><b>1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>1.1.0-SNAPSHOT</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/archetypes/java_app/customize.html b/archetypes/java_app/customize.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Customize Java Applications &mdash; sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation</title>
+    <title>Customize Java Applications &mdash; sbt-native-packager 1.1.0-SNAPSHOT documentation</title>
 
     <link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce',
+        VERSION:     '1.1.0-SNAPSHOT',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../../_static/js/jquery-fix.js"></script>
     <script type="text/javascript" src="../../_static/bootstrap-3.2.0/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../../_static/bootstrap-sphinx.js"></script>
-    <link rel="top" title="sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation" href="../../index.html" />
+    <link rel="top" title="sbt-native-packager 1.1.0-SNAPSHOT documentation" href="../../index.html" />
     <link rel="up" title="Java Application Archetype" href="index.html" />
     <link rel="next" title="Generating files for the package" href="generating-files.html" />
     <link rel="prev" title="My First Packaged Project" href="my-first-project.html" />
@@ -51,7 +51,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           sbt-native-packager</a>
-        <span class="navbar-text navbar-version pull-left"><b>1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>1.1.0-SNAPSHOT</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/archetypes/java_app/generating-files.html b/archetypes/java_app/generating-files.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Generating files for the package &mdash; sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation</title>
+    <title>Generating files for the package &mdash; sbt-native-packager 1.1.0-SNAPSHOT documentation</title>
 
     <link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce',
+        VERSION:     '1.1.0-SNAPSHOT',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../../_static/js/jquery-fix.js"></script>
     <script type="text/javascript" src="../../_static/bootstrap-3.2.0/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../../_static/bootstrap-sphinx.js"></script>
-    <link rel="top" title="sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation" href="../../index.html" />
+    <link rel="top" title="sbt-native-packager 1.1.0-SNAPSHOT documentation" href="../../index.html" />
     <link rel="up" title="Java Application Archetype" href="index.html" />
     <link rel="next" title="Writing Documentation" href="writing-documentation.html" />
     <link rel="prev" title="Customize Java Applications" href="customize.html" />
@@ -51,7 +51,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           sbt-native-packager</a>
-        <span class="navbar-text navbar-version pull-left"><b>1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>1.1.0-SNAPSHOT</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/archetypes/java_app/gettingstarted.html b/archetypes/java_app/gettingstarted.html
@@ -5,7 +5,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Getting Started &mdash; sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation</title>
+    <title>Getting Started &mdash; sbt-native-packager 1.1.0-SNAPSHOT documentation</title>
 
     <link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce',
+        VERSION:     '1.1.0-SNAPSHOT',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -28,7 +28,7 @@
     <script type="text/javascript" src="../../_static/js/jquery-fix.js"></script>
     <script type="text/javascript" src="../../_static/bootstrap-3.2.0/js/bootstrap.min.js"></script>
     <script type="text/javascript" src="../../_static/bootstrap-sphinx.js"></script>
-    <link rel="top" title="sbt-native-packager 1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce documentation" href="../../index.html" />
+    <link rel="top" title="sbt-native-packager 1.1.0-SNAPSHOT documentation" href="../../index.html" />
     <link rel="up" title="Java Application Archetype" href="index.html" />
     <link rel="next" title="My First Packaged Project" href="my-first-project.html" />
     <link rel="prev" title="Java Application Archetype" href="index.html" />
@@ -51,7 +51,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           sbt-native-packager</a>
-        <span class="navbar-text navbar-version pull-left"><b>1.1-b7f5f74d4c4e71a268bea6ac6f4825e30005e1ce</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>1.1.0-SNAPSHOT</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">