sbt-native-packager
API
Generated with
sbt-native-packager/com.typesafe.sbt/SbtNativePackager

SbtNativePackager

com.typesafe.sbt.SbtNativePackager
object SbtNativePackager extends AutoPlugin

==SBT Native Packager Plugin==

This is the top level plugin for the sbt native packager. You don't have to enable this by yourself, instead we recommend using an archetype for this.

Currently you can choose between

  • JavaAppPackaging
  • JavaServerPackaging
  • AkkaAppPackging

==Configuration==

The are a few settings you should set if you want to build package no matter what format.

maintainer := "Your name <[email protected]>"
packageDescription := "A short description of your application"

For all other general settings take a look at com.typesafe.sbt.packager.NativePackagerKeys

Attributes

Example

Enable the plugin in the build.sbt

  enablePlugins(SbtNativePackager)
Graph
Supertypes
class AutoPlugin
trait PluginsFunctions
class Basic
trait Plugins
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

object autoImport extends NativePackagerKeys

imports all com.typesafe.sbt.packager.NativePackagerKeys and two objects:

imports all com.typesafe.sbt.packager.NativePackagerKeys and two objects:

===NativePackagerKeys===

This inclues ''all'' available keys provided by the sbt-native-packager. Used it if a setting/task key is not in scope.

NativePackagerKeys.notAutomaticallyImported := "cool!"

===NativePackagerHelper===

This object contains a set of helper methods for working with mappings.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
autoImport.type
object packageArchetype

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

Value members

Inherited methods

def &&(o: Basic): Plugins

Attributes

Inherited from:
Basic
def allRequirements: PluginTrigger

This plugin is activated when all required plugins are present.

This plugin is activated when all required plugins are present.

Attributes

Inherited from:
PluginsFunctions
def buildSettings: Seq[Setting[_]]

The Setting to add to the build scope for each project that activates this AutoPlugin. The settings returned here are guaranteed to be added to a given build scope only once regardless of how many projects for that build activate this AutoPlugin.

The Setting to add to the build scope for each project that activates this AutoPlugin. The settings returned here are guaranteed to be added to a given build scope only once regardless of how many projects for that build activate this AutoPlugin.

Attributes

Inherited from:
AutoPlugin
def derivedProjects(proj: ProjectDefinition[_]): Seq[Project]

The Projects to add to the current build based on an existing project.

The Projects to add to the current build based on an existing project.

Attributes

Inherited from:
AutoPlugin
def empty: Plugins

Plugins instance that doesn't require any Pluginss.

Plugins instance that doesn't require any Pluginss.

Attributes

Inherited from:
PluginsFunctions
def extraProjects: Seq[Project]

The Projects to add to the current build.

The Projects to add to the current build.

Attributes

Inherited from:
AutoPlugin
def globalSettings: Seq[Setting[_]]

The Settings to add to the global scope exactly once if any project activates this AutoPlugin.

The Settings to add to the global scope exactly once if any project activates this AutoPlugin.

Attributes

Inherited from:
AutoPlugin
def noTrigger: PluginTrigger

This plugin is activated only when it is manually activated.

This plugin is activated only when it is manually activated.

Attributes

Inherited from:
PluginsFunctions
def projectConfigurations: Seq[Configuration]

The Configurations to add to each project that activates this AutoPlugin.

The Configurations to add to each project that activates this AutoPlugin.

Attributes

Inherited from:
AutoPlugin
def requires: Plugins

This AutoPlugin requires the plugins the Plugins matcher returned by this method. See trigger.

This AutoPlugin requires the plugins the Plugins matcher returned by this method. See trigger.

Attributes

Inherited from:
AutoPlugin
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
AutoPlugin -> Any
Inherited from:
AutoPlugin
def trigger: PluginTrigger

Determines whether this AutoPlugin will be activated for this project when the requires clause is satisfied.

Determines whether this AutoPlugin will be activated for this project when the requires clause is satisfied.

When this method returns allRequirements, and requires method returns Web && Javascript, this plugin instance will be added automatically if the Web and Javascript plugins are enabled.

When this method returns noTrigger, and requires method returns Web && Javascript, this plugin instance will be added only if the build user enables it, but it will automatically add both Web and Javascript.

Attributes

Inherited from:
AutoPlugin

Concrete fields

val Debian: Configuration
val Docker: Configuration
val Linux: Configuration
val Rpm: Configuration
val Universal: Configuration
val UniversalDocs: Configuration
val UniversalSrc: Configuration
val Windows: Configuration
lazy override val projectSettings: Seq[Setting[_]]

The Settings to add in the scope of each project that activates this AutoPlugin.

The Settings to add in the scope of each project that activates this AutoPlugin.

Attributes

Inherited fields

val label: String

Attributes

Inherited from:
AutoPlugin
Generated with