Plugin for sbt to create OSGi bundles.
sbt-osgi is a plugin for sbt. In order to install sbt, please refer to the sbt 1.x). Please make sure that you are using a suitable version of sbt:
- sbt-osgi 0.9.{4-x} -> sbt 1.6.2+ (older versions of sbt may work but 1.6.2+ supports all JDK LTS versions)
As sbt-osgi is a plugin for sbt, it is installed like any other sbt plugin, that is by mere configuration: just add sbt-osgi to your global or local plugin definition. Global plugins are defined in ~/.sbt/<SBT_VERSION>/plugins/plugins.sbt and local plugins are defined in project/plugins.sbt in your project.
In order to add sbt-osgi as a plugin, just add the below setting to the relevant plugin definition, paying attention to blank lines between settings:
// Other stuff
addSbtPlugin("com.github.sbt" % "sbt-osgi" % "0.9.11")If you want to use the latest and greatest features, you can instead have sbt depend on and locally build the current source snapshot by adding the following to your plugin definition file.
Example <PROJECT_ROOT>/project/plugins.sbt:
lazy val plugins = (project in file("."))
.dependsOn(sbtOsgi)
// Other stuff
def sbtOsgi = uri("git://github.com/sbt/sbt-osgi.git")As, since version 0.8.0, sbt-osgi uses the sbt 0.13.5 Autoplugin feature, it can be enabled for individual projects like any other sbt Autoplugin. For more information on enabling and disabling plugins, refer to the sbt plugins tutorial.
Example <PROJECT_ROOT>/build.sbt:
enablePlugins(SbtOsgi)To also override the default publish behaviour, also add the osgiSettings settings to your project via your preferred method.
Example <PROJECT_ROOT>/build.sbt:
// Other settings
osgiSettingsAdd the below line to your sbt build definition, which adds the task osgiBundle which creates an OSGi bundle for your project and also changes the publish task to publish an OSGi bundle instead of a raw JAR archive. Again, pay attention to the blank line between settings:
// Other stuff
osgiSettingsIf you just want osgiBundle, i.e. don't want to change the behavior of publish:
// Other stuff
defaultOsgiSettings
sbt-osgi can be configured with the following settings:
bundleActivator: value forBundle-Activatorheader, default isNonebundleRequiredExecutionEnvironment: value forBundle-RequiredExecutionEnvironmentheader, default is an empty string.bundleSymbolicName: value forBundle-SymbolicNameheader, default isorganizationplusnamebundleVersion: value forBundle-Versionheader, default isversiondynamicImportPackage: values forDynamic-ImportPackageheader, default is the empty sequenceexportPackage: values forExport-Packageheader, default is the empty sequenceimportPackage: values forImport-Packageheader, default is*fragmentHost: value forFragment-Hostheader, default isNoneprivatePackage: values forPrivate-Packageheader, default isOsgiKeys.bundleSymbolicNameplus.*requireBundle: values forRequire-Bundleheader, default is the empty sequenceadditionalHeaders: map of additional headers to be passed to BND, default is the empty sequenceembeddedJars: list of dependencies to embed inside the bundle which are automatically added toBundle-ClasspathexplodedJars: list of jarfiles to explode into the bundlerequireCapability: value forRequire-Capabilityheader, defaults toosgi.ee;filter:="(&(osgi.ee=JavaSE)(version=*PROJECT JAVAC VERSION*))"failOnUndecidedPackage: allows failing the build when a package is neither exported nor private (instead of silently dropping it),falseby default to be compatible with previous behaviour
Example build.sbt:
organization := "com.github.sbt"
name := "osgi.demo"
version := "1.0.0"
enablePlugins(SbtOsgi)
libraryDependencies += "org.osgi" % "org.osgi.core" % "4.3.0" % "provided"
osgiSettings
OsgiKeys.exportPackage := Seq("com.github.sbt.osgidemo")
OsgiKeys.bundleActivator := Option("com.github.sbt.osgidemo.internal.Activator")This code is open source software licensed under the Apache 2.0 License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent