Support Mac OS X app bundle

[choffmeister]

Are there any efforts to support app bundles for Mac OS X like https://github.com/sbt/sbt-appbundle does? Sadly the sbt-appbundle package lacks maintainence...

[muuki88]

Our next stop is looking to be windows. However feel free to provide a pull request. If you need any help, feel free to ask.

You can take a look at #236 for some guidance of how to implement a new feature from scratch.

[jsuereth]

So, we DO support creating DMG files. However, Mac OSX app bundles are self-admittedly a moving target (unstable). The likelihood of anyone keeping up-to-date is low. The "best practice" currently is to use the GUI to make a template bundle and then just copy-modify that.

We may support this use case in the future, but It's not something we'd dive into immediately. I've done the research for how to generate app-bundles, and implemented the sane bits (creating a DMG).

[choffmeister]

There are indeed a moving target, but the basic features are stable. The sbt-appbundle package is 2 years old and apart from updating the Scala and SBT version nothing has been done since then. But still, it generates working xxx.app bundles today.

I will try to kick off a PR for a side branch with the basic .app generation this weekend.

On 16 May 2014, at 15:10, Josh Suereth [email protected] wrote:

So, we DO support creating DMG files. However, Mac OSX app bundles are self-admittedly a moving target (unstable). The likelihood of anyone keeping up-to-date is low. The "best practice" currently is to use the GUI to make a template bundle and then just copy-modify that.

We may support this use case in the future, but It's not something we'd dive into immediately. I've done the research for how to generate app-bundles, and implemented the sane bits (creating a DMG).

—
Reply to this email directly or view it on GitHub.

[jsuereth]

@choffmeister That'd be great. You probably want to create a new osx configuration for this, as well as hook from JavaApp archetype to the OSX configuration. Hopefully the DMG stuff I added is helpful :)

For testing, please run scripted osx/* and add tests as needed. Looking forward to seeing what you come up with!

[choffmeister]

I'm still on it but at the moment I am occupied with other things. Have send some PRs to the original sbt-appbundle plugin and hope to bring the ideas and improvents anytime soon into this plugin.

[muuki88]

Awesome! Thanks for the update

[mariussoutier]

👍 Looking forward to this!

[muuki88]

@choffmeister , any updates on this?

[metasim]

@choffmeister , @muuki88 With the JDKPackager plugin, this is (arguably) covered. What do we need to do to close this issue?

[muuki88]

@metasim you're right. I think there is a dmg-doc section. We should reference the jdkPackager there.

[akauppi]

Seconding this. Can help to test.

[muuki88]

@akauppi That would be awesome. The current version 1.0.2 should have everything you need to do so. The default jdkPackagerType is installer, so on MacOS X this should generate dmg and app files. However you can set various types in your build.sbt

enablePlugins(JDKPackagerPlugin)

// simple dmg
jdkPackagerType := "dmg"

// macos app
jdkPackagerType := "mac.appStore"

and then run

sbt jdkPackager:packageBin

@metasim correct me if anything should be incorrect.

[mariussoutier]

Will this include an entire JRE?

[muuki88]

AFAIK this is configurable

[metasim]

@muuki88 As far as I know, that should work, except I've never tried the mac.appStore type myself.
These are the currently valid options: all, deb, dmg, exe, image, installer, mac.appStore, msi, none, pkg, rpm. Wondering if I should have made a set of case objects instead of using a string here.

On MacOS, if you select installer, it creates both .dmg and .pkg packages (the latter being more like the traditional windows installer).

@mariussoutier I does indeed include the JRE. I'm not sure if you can configure it to deploy without it. You'd have to check the JavaFX Ant Task documentation. Know that a build.xml file is generated in then target/jdkpackager directory, which you can inspect/tweak to try things out via running Ant directly. If you find something you want but isn't currently supported in the plugin, then you can intercept the task that writes that file to apply additional XML transforms on it if you had to, then file a feature request or PR to add it to the plugin. One thing I haven't figured out how to do is have the installer include other resources (e.g. from the mappings setting) that aren't inside the .app bundle, but co-located in the .dmg. Not even sure if it's possible with the Oracle tools.

[mariussoutier]

Thanks for the info. Including the JRE is a sensible default to avoid the "You have to install Java" dialog.

[metasim]

I agree... huge simplification. But I actually think the reason they originally did it was because Apple wouldn't allow anything in the app store that required additional downloads :-/

[Christewart]

Is there any updates on this?

[muuki88]

Not really. If some one is willing to make a pull request implementing this, I'm happy to merge 😊