deprecate scalaModuleSettingsJVM, use scalaModuleOsgiSettings instead

Author: lrytz

README.md

@@ -4,6 +4,7 @@ This is an sbt 1.x plugin for building Scala modules.
 
 ## What modules use it?
 
+* [travis-test](https://github.com/lrytz/travis-test) (example project for testing this plugin and tag-driven releases)
 * [scala-async](https://github.com/scala/scala-async)
 * [scala-collection-compat](https://github.com/scala/scala-collection-compat)
 * [scala-collection-contrib](https://github.com/scala/scala-collection-contrib)
@@ -18,7 +19,7 @@ This is an sbt 1.x plugin for building Scala modules.
 ## Why this plugin?
 
 Having a shared plugin reduces duplication between the above
-repositories.  Reducing duplication makes maintenance easier and
+repositories. Reducing duplication makes maintenance easier and
 helps ensure consistency.
 
 A major feature of the plugin is automated tag-based publishing using
@@ -28,14 +29,14 @@ The plugin also brings in
   - sbt-travisci to set the `scalaVersion` and `crossScalaVersions`
   - sbt-dynver to set the `version` based on the git history
   - sbt-header
-  - sbt-osgi
+  - sbt-osgi (only enabled when using `scalaModuleOsgiSettings`)
 
 ## Usage
 
 Add the plugin to the `project/plugins.sbt` file:
 
 ```
-addSbtPlugin("org.scala-lang.modules" % "sbt-scala-module" % "2.1.0")
+addSbtPlugin("org.scala-lang.modules" % "sbt-scala-module" % "2.2.0")
 ```
 
 Then, in your `build.sbt` add:
@@ -45,14 +46,14 @@ Then, in your `build.sbt` add:
 // main project (see e.g. scala-parallel-collections)
 ScalaModulePlugin.scalaModuleSettings
 
-// For JVM projects
-ScalaModulePlugin.scalaModuleSettingsJVM
+// If making an OSGi bundle
+ScalaModulePlugin.scalaModuleOsgiSettings
 
 name         := "<module name>"
 repoName     := "<GitHub repo name>" // the repo under github.com/scala/, only required if different from name
 organization := "<org>"              // only required if different from "org.scala-lang.modules"
 
-mimaPreviousVersion := Some("1.0.0") // enables MiMa (`None` by default, which disables it)
+scalaModuleMimaPreviousVersion := Some("1.0.0") // enables MiMa (`None` by default, which disables it)
 
 OsgiKeys.exportPackage := Seq(s"<exported package>;version=${version.value}")
 
@@ -61,13 +62,13 @@ OsgiKeys.exportPackage := Seq(s"<exported package>;version=${version.value}")
 
 Scala versions are defined in `.travis.yml`.
 
-Cross-building with Scala.js and Scala Native is possible, see scala-xml or scala-parser-combinators for example.
+Cross-building with Scala.js and Scala Native is possible, see travis-test, scala-xml or scala-parser-combinators for example.
 
 These additional settings are enabled by `scalaModuleSettings`:
   - `scalacOptions in (Compile, compile) ++= Seq("-feature", "-deprecation", "-unchecked", "-Xlint")`
   - A `projectName.properties` file is generated and packaged
   - `fork in Test := true` to work around some classpath clashes with scala-xml
-  - POM and OSGi metadata
+  - POM metadata
 
 The following settings are also available:
   - `enableOptimizer` adds `-opt-inline-from:<sources>` or `-opt:l:project` or `-optimize` to `scalacOptions in (Compile, compile)`,
@@ -106,6 +107,7 @@ Tag the release and add release notes to https://github.com/scala/sbt-scala-modu
 
 - Sign in to Bintray (https://bintray.com/login) or create an "Open Source" account (https://bintray.com/signup/oss)
 - Check if you have a repository named `sbt-plugins`. If not, create it (Name: sbt-plugins, Type: Generic).
+- Make sure to use Java 8
 - Make sure the current `HEAD` is a tagged revision. In sbt, `version` (set by sbt-git) should be according to a tag.
 
       > version

src/main/scala/ScalaModulePlugin.scala

@@ -53,7 +53,7 @@ object ScalaModulePlugin extends AutoPlugin {
   )
 
   /**
-   * Enable `-opt:l:inline`, `-opt:l:classpath` or `-optimize`, depending on the scala version.
+   * Enable `-opt:l:inline`, `-opt:l:project` or `-optimize`, depending on the scala version.
    */
   lazy val enableOptimizer: Setting[_] = scalacOptions in (Compile, compile) ++= {
     val Ver = """(\d+)\.(\d+)\.(\d+).*""".r
@@ -138,8 +138,26 @@ object ScalaModulePlugin extends AutoPlugin {
     )
   ) ++ mimaSettings
 
+  @deprecated("use scalaModuleOsgiSettings instead", "2.2.0")
   lazy val scalaModuleSettingsJVM: Seq[Setting[_]] = scalaModuleOsgiSettings
 
+  // enables the SbtOsgi plugin and defines some default settings
+  lazy val scalaModuleOsgiSettings: Seq[Setting[_]] = SbtOsgi.projectSettings ++ SbtOsgi.autoImport.osgiSettings ++ Seq(
+    OsgiKeys.bundleSymbolicName  := s"${organization.value}.${name.value}",
+    OsgiKeys.bundleVersion       := osgiVersion.value,
+
+    // Sources should also have a nice MANIFEST file
+    packageOptions in packageSrc := Seq(Package.ManifestAttributes(
+      ("Bundle-SymbolicName", s"${organization.value}.${name.value}.source"),
+      ("Bundle-Name", s"${name.value} sources"),
+      ("Bundle-Version", osgiVersion.value),
+      ("Eclipse-SourceBundle", s"""${organization.value}.${name.value};version="${osgiVersion.value}";roots:="."""")
+    ))
+  )
+
+  // a setting-transform to turn the regular version into something osgi can deal with
+  private val osgiVersion = version(_.replace('-', '.'))
+
   // adapted from https://github.com/lightbend/migration-manager/blob/0.3.0/sbtplugin/src/main/scala/com/typesafe/tools/mima/plugin/SbtMima.scala#L112
   private def artifactExists(organization: String, name: String, scalaBinaryVersion: String, version: String, ivy: IvySbt, s: TaskStreams): Boolean = {
     val moduleId = ModuleID(organization, s"${name}_$scalaBinaryVersion", version)
@@ -154,7 +172,7 @@ object ScalaModulePlugin extends AutoPlugin {
   private val canRunMima       = taskKey[Boolean]("Decides if MiMa should run.")
   private val runMimaIfEnabled = taskKey[Unit]("Run MiMa if mimaPreviousVersion and the module can be resolved against the current scalaBinaryVersion.")
 
-  private lazy val mimaSettings: Seq[Setting[_]] = MimaPlugin.mimaDefaultSettings ++ Seq(
+  private lazy val mimaSettings: Seq[Setting[_]] = Seq(
     scalaModuleMimaPreviousVersion := None,
 
     // We're not using `%%` here in order to support both jvm and js projects (cross version `_2.12` / `_sjs0.6_2.12`)
@@ -184,22 +202,6 @@ object ScalaModulePlugin extends AutoPlugin {
       (test in Test).value
     }
   )
-
-  // a setting-transform to turn the regular version into something osgi can deal with
-  private val osgiVersion = version(_.replace('-', '.'))
-
-  private lazy val scalaModuleOsgiSettings = SbtOsgi.projectSettings ++ SbtOsgi.autoImport.osgiSettings ++ Seq(
-    OsgiKeys.bundleSymbolicName  := s"${organization.value}.${name.value}",
-    OsgiKeys.bundleVersion       := osgiVersion.value,
-
-    // Sources should also have a nice MANIFEST file
-    packageOptions in packageSrc := Seq(Package.ManifestAttributes(
-                          ("Bundle-SymbolicName", s"${organization.value}.${name.value}.source"),
-                          ("Bundle-Name", s"${name.value} sources"),
-                          ("Bundle-Version", osgiVersion.value),
-                          ("Eclipse-SourceBundle", s"""${organization.value}.${name.value};version="${osgiVersion.value}";roots:="."""")
-                      ))
-  )
 }