Skip to content

Commit

Permalink
Merge pull request #366 from sbt/docs/release-preparations
Browse files Browse the repository at this point in the history
Preparing documentation for next release
  • Loading branch information
muuki88 committed Oct 1, 2014
2 parents 712ae9d + 62ffbcf commit 0b2b6df
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ Add the following to your `project/plugins.sbt` file:

```scala
// for sbt 0.12.x and scala 2.9.x
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.5-RC2")
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.5")

// for sbt 0.13.x and scala 2.10.x
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.8.0-M1")
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.8.0-M2")
```

For the native packager keys add this to your `build.sbt`
Expand Down
30 changes: 29 additions & 1 deletion src/sphinx/DetailedTopics/archetypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,29 @@ to your packaging for Debian. *Note:* All specified users are **deleted** on an
Akka Microkernel Application
----------------------------

Akka microkerneal application is simlar to a Java Command Line application. Instead to run the ``mainClass``, akka microkernel application need run java with main class ``akka.kernel.Main``. The bash/bat script that starts up a Akka application is copied from Akka distribution. To use this archetype in your build, do the following in your ``build.sbt``:
An Akka microkernel application is simlar to a Java Command Line application. Instead of running the classic ``mainClass``,
an Akka microkernel application instantiates and runs a subclass of
`Bootable <https://github.com/akka/akka/blob/master/akka-kernel/src/main/scala/akka/kernel/Main.scala>`_ . A minimal example
could look like this

.. code-block:: scala
class HelloKernel extends Bootable {
val system = ActorSystem("hellokernel")
def startup = {
// HelloActor and Start case object must of course be defined
system.actorOf(Props[HelloActor]) ! Start
}
def shutdown = {
system.terminate()
}
}
The *bash/bat* script that starts up the Akka application is copied from the Akka distribution.

To use this archetype in your build, add the following to your ``build.sbt``:

.. code-block:: scala
Expand All @@ -136,6 +158,12 @@ Akka microkerneal application is simlar to a Java Command Line application. Inst
mainClass in Compile := Some("HelloKernel")
For more information take a look at the akka docs

* `Akka microkernel <http://doc.akka.io/docs/akka/snapshot/scala/microkernel.html>`_
* `akka.kernel.Main source <https://github.com/akka/akka/blob/master/akka-kernel/src/main/scala/akka/kernel/Main.scala>`_
* `akka.kernel.Bootable docs <http://doc.akka.io/api/akka/snapshot/index.html#akka.kernel.Bootable>`_


Overriding Templates
--------------------
Expand Down
2 changes: 1 addition & 1 deletion src/sphinx/GettingStartedApplications/MyFirstProject.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ and documents to users which version of sbt you require for the build.

Next, let's add the native packager to our build by created a ``project/plugins.sbt`` file with the following contents ::

addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.5-RC1")
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.8.0-M2")

Now, the build needs to be configured for packaging. Let's define the ``build.sbt`` file as follows

Expand Down
4 changes: 2 additions & 2 deletions src/sphinx/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The sbt-native-packager is a plugin. To use it, first create a ``project/plugins

.. code-block:: scala
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.1")
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.8.0-M2")
Also, each operating system requires its own tools for download.
Expand Down Expand Up @@ -62,4 +62,4 @@ Creating Docker images requires the use of the following command line tools:
- ``docker``

It is currently not possible to provide authentication for Docker repositories from within the build. The ``docker`` binary used by the build should already have been configured with the appropriate authentication details.
See https://docs.docker.com/reference/commandline/cli/#login.
See https://docs.docker.com/reference/commandline/cli/#login.

0 comments on commit 0b2b6df

Please sign in to comment.