Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sbt/sbt-native-packager

sbt Native Packager
https://github.com/sbt/sbt-native-packager

deb docker native-packages rpm sbt sbt-docker sbt-plugin scala

Last synced: 3 days ago
JSON representation

sbt Native Packager

Host: GitHub
URL: https://github.com/sbt/sbt-native-packager
Owner: sbt
License: bsd-2-clause
Created: 2011-12-20T02:04:49.000Z (about 13 years ago)
Default Branch: main
Last Pushed: 2024-11-25T09:00:27.000Z (about 2 months ago)
Last Synced: 2025-01-01T21:04:59.915Z (10 days ago)
Topics: deb, docker, native-packages, rpm, sbt, sbt-docker, sbt-plugin, scala
Language: Scala
Homepage: https://sbt-native-packager.readthedocs.io/en/stable/
Size: 17.1 MB
Stars: 1,597
Watchers: 53
Forks: 443
Open Issues: 150
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-sbt-plugins - sbt-native-packager - The goal is to be able to bundle up Scala software built with SBT for native packaging systems, like deb, rpm, homebrew, msi. (BUILD & RELEASE)
awesome-list-docker - sbt-native-packager

README

        # SBT Native Packager #

[![Build Status](https://api.travis-ci.org/sbt/sbt-native-packager.png?branch=master)](https://travis-ci.org/sbt/sbt-native-packager)

[![Build status](https://ci.appveyor.com/api/projects/status/pbxd0untlcst4we7/branch/master?svg=true)](https://ci.appveyor.com/project/muuki88/sbt-native-packager/branch/master)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0e9a7ec769c84e578f4550bf7da6bf05)](https://www.codacy.com/app/nepomukseiler/sbt-native-packager?utm_source=github.com&utm_medium=referral&utm_content=sbt/sbt-native-packager&utm_campaign=Badge_Grade)

[![sbt-native-packager Scala version support](https://index.scala-lang.org/sbt/sbt-native-packager/sbt-native-packager/latest-by-scala-version.svg?targetType=Sbt)](https://index.scala-lang.org/sbt/sbt-native-packager/sbt-native-packager)

[![Join the chat at https://gitter.im/sbt/sbt-native-packager](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sbt/sbt-native-packager?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Documentation Status](https://readthedocs.org/projects/sbt-native-packager/badge/?version=latest)](http://sbt-native-packager.readthedocs.org/en/latest/?badge=latest)

![Native Packager Logo](src/sphinx/static/np_logo_full_horizontal_transparent.png)

## Goal ##

SBT native packager lets you build application packages in native formats. It offers

different archetypes for common configurations, such as simple Java apps or server applications.

## Issues/Discussions ##

*  **Discussion/Questions**:

  If you wish to ask questions about the native packager we're active on [Stack Overflow](http://stackoverflow.com/questions/tagged/sbt). You can either use the `sbt` tag or the

  `sbt-native-packager` tag.  They also have far better search support for working around issues.

* **Docs**:

  [Our docs are available online](http://sbt-native-packager.readthedocs.org/en/latest/).  If you'd like to help improve the docs, they're part of this

  repository in the `src/sphinx` directory. [ScalaDocs](http://www.scala-sbt.org/sbt-native-packager/latest/api/#package) are also available.

  The old documentation can be found [here](http://www.scala-sbt.org/sbt-native-packager/)

* **Issues/Feature Requests**:

  Finally, any bugs or features you find you need, please report to our [issue tracker](https://github.com/sbt/sbt-native-packager/issues/new).

  Please check the [compatibility matrix](https://github.com/sbt/sbt-native-packager/wiki/Tested-On) to see if your system is able to

  produce the packages you want.

## Features ##

* Build [native packages][formats] for different systems

  * Universal `zip`,`tar.gz`, `xz` archives

  * `deb` and `rpm` packages for Debian/RHEL based systems

  * `dmg` for macOS

  * `msi` for Windows

  * `docker` images

  * `graalvm` native images

* Provide archetypes for common use cases

  * [Java application][] with start scripts for Linux, macOS and Windows

  * [Java server application][] adds support for service managers:s

    * Systemd

    * Systemv

    * Upstart

* Java8 [jdkpackager][] wrapper

* Java11 [jlink][] wrapper

* Optional JDeb integration for cross-platform Debian builds

* Optional Spotify docker client integration

## Installation ##

Add the following to your `project/plugins.sbt` file:

```scala

// for autoplugins

addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "")

```

In your `build.sbt` enable the plugin you want. For example the

`JavaAppPackaging`.

```scala

enablePlugins(JavaAppPackaging)

```

Or if you need a server with autostart support

```scala

enablePlugins(JavaServerAppPackaging)

```

## Build ##

If you have enabled one of the archetypes (app or server),

you can build your application with

```bash

sbt /packageBin

```

### Examples

```bash

# universal zip

sbt Universal/packageBin

# debian package

sbt Debian/packageBin

# rpm package

sbt Rpm/packageBin

# docker image

sbt Docker/publishLocal

# graalvm image

sbt GraalVMNativeImage/packageBin

```

Read more in the specific [format documentation][formats] on how to configure and build your package.

## Documentation ##

There's a complete "getting started" guide and more detailed topics available at [the sbt-native-packager site](http://www.scala-sbt.org/sbt-native-packager/).

Please feel free to [contribute documentation](https://github.com/sbt/sbt-native-packager/tree/master/src/sphinx), or raise issues where you feel it may be lacking.

## Contributing ##

Please read the [contributing.md](CONTRIBUTING.md) on how to build and test native-packager.

## Related SBT Plugins ##

These are a list of plugins that either use sbt-native-packager, provide additional features

or provide a richer API for a single packaging format.

- [sbt-aether](https://github.com/arktekk/sbt-aether-deploy)

- [sbt-assembly](https://github.com/sbt/sbt-assembly)

- [sbt-docker](https://github.com/marcuslonnberg/sbt-docker)

  - This is in addition to the built-in [Docker Plugin](http://www.scala-sbt.org/sbt-native-packager/formats/docker.html) from  sbt-native.  Both generate docker images. `sbt-docker` provides more customization abilities, while the `DockerPlugin` in this project  integrates more directly with predefined archetypes.

- [sbt-heroku](https://github.com/heroku/sbt-heroku)

- [sbt-kubeyml](https://github.com/vaslabs/sbt-kubeyml)

- [sbt-newrelic](https://github.com/gilt/sbt-newrelic)

- [sbt-packager](https://github.com/en-japan/sbt-packer)

- [sbt-package-courier](https://github.com/alkersan/sbt-package-courier)

[formats]: http://www.scala-sbt.org/sbt-native-packager/gettingstarted.html#packaging-formats

[Java application]: http://www.scala-sbt.org/sbt-native-packager/archetypes/java_app/index.html

[Java server application]: http://www.scala-sbt.org/sbt-native-packager/archetypes/java_server/index.html

[My First Packaged Server Project guide]: http://www.scala-sbt.org/sbt-native-packager/GettingStartedServers/MyFirstProject.html

[jdkpackager]: http://www.scala-sbt.org/sbt-native-packager/formats/jdkpackager.html

[jlink]: https://docs.oracle.com/en/java/javase/11/tools/jlink.html

## Maintainers ##

- Nepomuk Seiler (@muuki88)

- Alexey Kardapoltsev (@kardapoltsev)

- Derek Wickern (@dwickern)

- Felix Satyaputra (@fsat)

## Credits ##

- [Josh Suereth](https://twitter.com/jsuereth) for the initial developement

- [Sascha Rinaldi](http://www.imagelab.net/) for the native-packager logo