diff --git a/src/reference/01-General-Info/04-Bintray-For-Plugins.md b/src/reference/01-General-Info/04-Bintray-For-Plugins.md index 5f580f11..3201e5a8 100644 --- a/src/reference/01-General-Info/04-Bintray-For-Plugins.md +++ b/src/reference/01-General-Info/04-Bintray-For-Plugins.md @@ -2,169 +2,22 @@ out: Bintray-For-Plugins.html --- + [UsingSonatype]: Using-Sonatype.html + Bintray For Plugins ------------------- -**This is currently in Beta mode.** - -sbt hosts their community plugin repository on -[Bintray](https://bintray.com/sbt). -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 additional 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 to create an Open Source Distribution Bintray Account. - -If you end up at the [Bintray home page](https://bintray.com), 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: - -- Name: sbt-plugins -- Type: Generic -- Desc: My sbt plugins -- Tags: sbt - -Once this is done, you can begin to configure your sbt-plugins to -publish to bintray. - -### Add the sbt-bintray plugin to your build. - -First, add the sbt-bintray to your plugin build. - -First, create a `project/bintray.sbt` file - -```scala -addSbtPlugin("org.foundweekends" % "sbt-bintray" % "$sbt_bintray_version$") -``` - -Next, a make sure your `build.sbt` file has the following settings - -```scala -ThisBuild / version := "" -ThisBuild / organization := "" -ThisBuild / description := "" - -// This is an example. sbt-bintray requires licenses to be specified -// (using a canonical name). -ThisBuild / licenses += ("Apache-2.0", url("https://www.apache.org/licenses/LICENSE-2.0.html")) - -lazy val root = (project in file(".")) - .settings( - sbtPlugin := true, - name := "", - 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 - -> *Note: bintray does not support snapshots. We recommend using -[git-revisions supplied by the sbt-git plugin](https://github.com/sbt/sbt-git#versioning-with-git)*. - -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](https://bintray.com). - -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 sbt-bintray plugin will save your -API key for future use. - -*NOTE: We have to do this before we can link our package to the sbt -org.* - -### 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](https://bintray.com/sbt/sbt-plugin-releases) -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. - -### Publishing your plugin to a private repository - -If you choose not provide your plugin to the community and instead publish it to a private repository using the process described above, you will need to add an appropriate resolver to the project that utilizes this plugin so that the project is able to find the plugin. In your build settings under `project/plugins.sbt` add the following: - -```scala -resolvers += Resolver.bintrayIvyRepo("YOUR ORG", "sbt-plugins"), - -addSbtPlugin("YOUR ORG" % "YOUR PLUGIN" % "YOUR PLUGIN VERSION") -``` +**We no longer use Bintray to host plugins.** -When publishing sbt plugins, Lightbend recommends using the default, Ivy-style repository formatting. This is automatically handled for you when referencing plugins from the community repository, but for private repositories, you need to explicitly add it using `Resolver.bintrayIvyRepo`... +First and foremost, we would like to thank JFrog for their continued support of sbt project and the Scala ecosystem. +Between 2014 and April, 2021 sbt hosted its community plugin repository on +[bintray.com/sbt](https://bintray.com/sbt). -### Summary +When JFrog sunsetted their Bintray product, they have proactively contacted us +and granted Scala Center open source sponsorship that allows us to use an online Artifactory instance. -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. +As of 2021-04-18, we have migrated all sbt plugins and sbt 0.13 artifacts to the Artifactory instance, +and redirected to point to it as well, +so existing builds should continue to work without making any changes today and after May 1st. +For plugin hosting, we will operate this as a read-only repository. +Any new plugin releases should migrate to using [Sonatype OSS][UsingSonatype].