Bintray For Plugins 

This is currently in Beta mode.

sbt hosts their community plugin repository on Bintray. Bintray is a repository hosting site, similar to github, which allows users to contribute their own plugins, while sbt can aggregate them together in a common repository.

This document walks you through the means to create your own repository for hosting your sbt plugins and then linking them into the sbt shared repository. This will make your plugins available for all sbt users without additonal configuration (besides declaring a dependency on your plugin).

To do this, we need to perform the following steps:

Create an Open Source Distribution account on Bintray 

First, go to https://bintray.com/signup/oss to create an Open Source Distribution Bintray Account.

If you end up at the Bintray home page, do NOT click on the Free Trial, but click on the link that reads “For Open Source Distribution Sign Up Here“.

Create a repository for your sbt plugins 

Now, we’ll create a repository to host our personal sbt plugins. In bintray, create a generic repository called sbt-plugins.

First, go to your user page and click on the new repository link:

You should see the following dialog:

Fill it out similarly to the above image, the settings are:

Once this is done, you can begin to configure your sbt-plugins to publish to bintray.

Add the bintray-sbt plugin to your build. 

First, add the bintray-sbt to your plugin build.

First, create a project/bintray.sbt file

addSbtPlugin("me.lessis" % "bintray-sbt" % "0.3.0")

Next, a make sure your build.sbt file has the following settings

import bintray.Keys._

lazy val commonSettings = Seq(
  version in ThisBuild := "<YOUR PLUGIN VERSION HERE>",
  organization in ThisBuild := "<INSERT YOUR ORG HERE>"
)

lazy val root = (project in file(".")).
  settings(commonSettings).
  settings(
    sbtPlugin := true,
    name := "<YOUR PLUGIN HERE>",
    description := "<YOUR DESCRIPTION HERE>",
    // This is an example.  bintray-sbt requires licenses to be specified 
    // (using a canonical name).
    licenses += ("Apache-2.0", url("https://www.apache.org/licenses/LICENSE-2.0.html")),
    publishMavenStyle := false,
    bintrayRepository := "sbt-plugins",
    bintrayOrganization in bintray := None
  )

Make sure your project has a valid license specified, as well as unique name and organization.

Make a release 

Once your build is configured, open the sbt console in your build and run

sbt> publish

The plugin will ask you for your credentials. If you don’t know where they are, you can find them on Bintray.

  1. Login to the website with your credentials.
  2. Click on your username
  3. Click on edit profile
  4. Click on API Key

This will get you your password. The bintray-sbt plugin will save your API key for future use.

Linking your package to the sbt organization 

Now that your plugin is packaged on bintray, you can include it in the community sbt repository. To do so, go to the Community sbt repository screen.

  1. Click the green include my package button and select your plugin.
  2. Search for your plugin by name and click on the link.
  3. Your request should be automatically filled out, just click send
  4. Shortly, one of the sbt repository admins will approve your link request.

From here on, any releases of your plugin will automatically appear in the community sbt repository. Congratulations and thank you so much for your contributions!

Linking your package to the sbt organization (sbt org admins) 

If you’re a member of the sbt organization on bintray, you can link your package to the sbt organization, but via a different means. To do so, first navigate to the plugin you wish to include and click on the link button:

After clicking this you should see a link like the following:

Click on the sbt/sbt-plugin-releases repository and you’re done! Any future releases will be included in the sbt-plugin repository.

Summary 

After setting up the repository, all new releases will automatically be included the sbt-plugin-releases repository, available for all users. When you create a new plugin, after the initial release you’ll have to link it to the sbt community repository, but the rest of the setup should already be completed. Thanks for you contributions and happy hacking.

Contents

sbt Reference Manual
    1. Bintray For Plugins