@@ -4,7 +4,6 @@ This is an sbt 1.x plugin for building Scala modules.
44
55## What modules use it?
66
7- * [ travis-test] ( https://github.com/lrytz/travis-test ) (example project for testing this plugin and tag-driven releases)
87* [ scala-async] ( https://github.com/scala/scala-async )
98* [ scala-collection-compat] ( https://github.com/scala/scala-collection-compat )
109* [ scala-collection-contrib] ( https://github.com/scala/scala-collection-contrib )
@@ -25,19 +24,17 @@ A major feature of the plugin is automated tag-based publishing using
2524sbt-ci-release. A release is made by pushing a tag to GitHub.
2625
2726The plugin also brings in
28- - sbt-travisci to set the ` scalaVersion ` and ` crossScalaVersions `
2927 - sbt-dynver to set the ` version ` based on the git history
28+ - sbt-version-policy to check the versioning policy using MiMa
3029 - sbt-header to automate copyright header maintenance
31- - sbt-mima-plugin to maintain binary compatibility
3230 - sbt-osgi, if enabled with ` scalaModuleOsgiSettings `
33- - sbt-version-policy to check the versioning policy
3431
3532## Usage
3633
3734Add the plugin to the ` project/plugins.sbt ` file:
3835
3936```
40- addSbtPlugin("org.scala-lang.modules" % "sbt-scala-module" % "2.2.3" )
37+ addSbtPlugin("org.scala-lang.modules" % "sbt-scala-module" % <version> )
4138```
4239
4340Then, in your ` build.sbt ` add:
@@ -61,20 +58,17 @@ OsgiKeys.exportPackage := Seq(s"<exported package>;version=${version.value}")
6158// Other settings
6259```
6360
64- Scala versions are defined in ` .travis.yml ` .
65-
66- Cross-building with Scala.js and Scala Native is possible, see travis-test, scala-xml or scala-parser-combinators for example.
61+ Cross-building with Scala.js and Scala Native is possible. See scala-xml or scala-parser-combinators for examples.
6762
6863These additional settings are enabled by ` scalaModuleSettings ` :
69- - ` scalacOptions in ( Compile, compile) ++= Seq("-feature", "-deprecation", "-unchecked", "-Xlint")`
64+ - ` Compile / compile / scalacOptions ++= Seq("-feature", "-deprecation", "-unchecked", "-Xlint") `
7065 - A ` projectName.properties ` file is generated and packaged
71- - ` fork in Test := true` to work around some classpath clashes with scala-xml
66+ - ` Test / fork := true` to work around some classpath clashes with scala-xml
7267 - POM metadata
7368
7469The following settings are also available:
75- - ` enableOptimizer ` adds ` -opt-inline-from:<sources> ` or ` -opt:l:project ` or ` -optimize ` to ` scalacOptions in ( Compile, compile) ` ,
70+ - ` enableOptimizer ` adds ` -opt-inline-from:<sources> ` or ` -opt:l:project ` or ` -optimize ` to ` Compile / compile / scalacOptions ` ,
7671 depending on the Scala version
77- - ` disablePublishing ` is useful for multi-project builds for projects that should not be published
7872
7973## Set up tag-based publishing
8074
@@ -91,7 +85,7 @@ The instructions here are a summary of the readme in https://github.com/olafurpg
9185 - Copy the public key to a key server
9286 - ` gpg --armor --export $LONG_ID `
9387 - http://keyserver.ubuntu.com:11371/
94- - Open the Settings panel on your project 's travis , define four secret env vars
88+ - In your repo 's Actions settings , define four secret env vars
9589 - ` PGP_PASSPHRASE ` the passphrase you chose above
9690 - ` PGP_SECRET ` the secret key in base64
9791 - macOS: ` gpg --armor --export-secret-keys $LONG_ID | base64 `
0 commit comments