├── .github └── workflows │ ├── ci.yml │ ├── cla.yml │ └── release.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── LICENSE ├── NOTICE ├── README.md ├── build.sbt ├── project ├── build.properties └── plugins.sbt └── src └── main └── scala └── ScalaModulePlugin.scala /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | on: 3 | push: 4 | branches: 5 | - main 6 | pull_request: 7 | jobs: 8 | test: 9 | strategy: 10 | fail-fast: false 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v4 14 | - uses: coursier/cache-action@v6 15 | - uses: actions/setup-java@v4 16 | with: 17 | distribution: temurin 18 | java-version: 8 19 | - uses: sbt/setup-sbt@v1 20 | - name: Test 21 | run: sbt test 22 | -------------------------------------------------------------------------------- /.github/workflows/cla.yml: -------------------------------------------------------------------------------- 1 | name: "Check Scala CLA" 2 | on: 3 | pull_request: 4 | jobs: 5 | cla-check: 6 | runs-on: ubuntu-latest 7 | steps: 8 | - name: Verify CLA 9 | uses: scala/cla-checker@v1 10 | with: 11 | author: ${{ github.event.pull_request.user.login }} 12 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | on: 3 | push: 4 | tags: ["*"] 5 | jobs: 6 | publish: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v4 10 | with: 11 | fetch-depth: 0 12 | - uses: actions/setup-java@v4 13 | with: 14 | distribution: temurin 15 | java-version: 8 16 | - uses: sbt/setup-sbt@v1 17 | - run: sbt ci-release 18 | env: 19 | PGP_PASSPHRASE: ${{secrets.PGP_PASSPHRASE}} 20 | PGP_SECRET: ${{secrets.PGP_SECRET}} 21 | SONATYPE_PASSWORD: ${{secrets.SONATYPE_PASSWORD}} 22 | SONATYPE_USERNAME: ${{secrets.SONATYPE_USERNAME}} 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | /.idea/ 3 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | all repositories in these organizations: 2 | 3 | * [scala](https://github.com/scala) 4 | * [scalacenter](https://github.com/scalacenter) 5 | * [lampepfl](https://github.com/lampepfl) 6 | 7 | are covered by the Scala Code of Conduct: https://scala-lang.org/conduct/ 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | sbt-scala-module 2 | Copyright (c) 2013-2025 EPFL 3 | Copyright (c) 2013-2025 Lightbend, Inc. dba Akka 4 | 5 | Licensed under the Apache License, Version 2.0 (the "License"). 6 | Unless required by applicable law or agreed to in writing, software 7 | distributed under the License is distributed on an "AS IS" BASIS, 8 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | See the License for the specific language governing permissions and 10 | limitations under the License. 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Scala modules sbt plugin 2 | 3 | This is an sbt 1.x plugin for building Scala modules. 4 | 5 | ## What modules use it? 6 | 7 | ### Former standard library 8 | 9 | * [scala-parser-combinators](https://github.com/scala/scala-parser-combinators) 10 | * [scala-swing](https://github.com/scala/scala-swing) 11 | * [scala-xml](https://github.com/scala/scala-xml) 12 | 13 | For historical reasons, these were originally part of the Scala standard library. They live on as modules since they are in the `scala.` namespace and keeping them there preserves source compatibility with old source code that uses them. They are now community-maintained and largely frozen in design, though still open to minor improvements. 14 | 15 | ### Standard library adjacent 16 | 17 | * [scala-async](https://github.com/scala/scala-async) 18 | * [scala-collection-compat](https://github.com/scala/scala-collection-compat) 19 | * [scala-java8-compat](https://github.com/scala/scala-java8-compat) 20 | * [scala-parallel-collections](https://github.com/scala/scala-parallel-collections) 21 | 22 | These modules are maintained by the Scala organization, with community input and participation. They have an especially close relationship with the Scala standard library (or, in the case of scala-async, the Scala 2 compiler). 23 | 24 | ### Future standard library? 25 | 26 | * [scala-library-next](https://github.com/scala/scala-library-next) 27 | * [scala-collection-contrib](https://github.com/scala/scala-collection-contrib) 28 | 29 | Code that could become part of the standard library in the future. 30 | 31 | ## Why this plugin? 32 | 33 | Having a shared plugin reduces duplication between the above 34 | repositories. Reducing duplication makes maintenance easier and 35 | helps ensure consistency. 36 | 37 | A major feature of the plugin is automated tag-based publishing using 38 | sbt-ci-release. A release is made by pushing a tag to GitHub. 39 | 40 | The plugin also brings in 41 | - sbt-dynver to set the `version` based on the git history 42 | - sbt-version-policy to check the versioning policy using MiMa 43 | - sbt-header to automate copyright header maintenance 44 | - sbt-osgi, if enabled with `scalaModuleOsgiSettings` 45 | 46 | ## Usage 47 | 48 | Add the plugin to the `project/plugins.sbt` file: 49 | 50 | ``` 51 | addSbtPlugin("org.scala-lang.modules" % "sbt-scala-module" % ) 52 | ``` 53 | 54 | Then, in your `build.sbt` add: 55 | 56 | ``` 57 | // In a multi-project build, you might want to apply these settings only to the 58 | // main project (see e.g. scala-parallel-collections) 59 | ScalaModulePlugin.scalaModuleSettings 60 | 61 | // If making an OSGi bundle 62 | ScalaModulePlugin.scalaModuleOsgiSettings 63 | 64 | name := "" 65 | repoName := "" // the repo under github.com/scala/, only required if different from name 66 | organization := "" // only required if different from "org.scala-lang.modules" 67 | 68 | versionPolicyIntention := Compatibility.BinaryAndSourceCompatible // enables MiMa (`Compatibility.None` by default, which disables it) 69 | 70 | OsgiKeys.exportPackage := Seq(s";version=${version.value}") 71 | 72 | // Other settings 73 | ``` 74 | 75 | Cross-building with Scala.js and Scala Native is possible. See scala-xml or scala-parser-combinators for examples. 76 | 77 | These additional settings are enabled by `scalaModuleSettings`: 78 | - `Compile / compile / scalacOptions ++= Seq("-feature", "-deprecation", "-unchecked", "-Xlint")` 79 | - A `projectName.properties` file is generated and packaged 80 | - `Test / fork := true` to work around some classpath clashes with scala-xml 81 | - POM metadata 82 | 83 | The following settings are also available: 84 | - `enableOptimizer` adds `-opt-inline-from:` or `-opt:l:project` or `-optimize` to `Compile / compile / scalacOptions`, 85 | depending on the Scala version 86 | 87 | ## Set up tag-based publishing 88 | 89 | The instructions here are a summary of the readme in https://github.com/olafurpg/sbt-ci-release and https://github.com/scalacenter/sbt-version-policy 90 | 91 | - Create a fresh GPG key: `gpg --gen-key` 92 | - Real name: use "project-name bot" 93 | - Email: "something@scala-lang.org" 94 | - Passphrase: generate one yourself 95 | - Get the key `LONG_ID` from the output and set `LONG_ID=6E8ED79B03AD527F1B281169D28FC818985732D9`. The output looks like this: 96 | 97 | pub rsa2048 2018-06-10 [SC] [expires: 2020-06-09] 98 | $LONG_ID 99 | - Copy the public key to a key server 100 | - `gpg --armor --export $LONG_ID` 101 | - http://keyserver.ubuntu.com:11371/ 102 | - In your repo's Actions settings, define four secret env vars 103 | - `PGP_PASSPHRASE` the passphrase you chose above 104 | - `PGP_SECRET` the secret key in base64 105 | - macOS: `gpg --armor --export-secret-keys $LONG_ID | base64` 106 | - ubuntu: `gpg --armor --export-secret-keys $LONG_ID | base64 -w0` 107 | - `SONATYPE_PASSWORD`: need that one 108 | - `SONATYPE_USERNAME`: that one too 109 | 110 | - Run `versionCheck` in the publishing process: `sbt versionCheck ci-release` 111 | -------------------------------------------------------------------------------- /build.sbt: -------------------------------------------------------------------------------- 1 | enablePlugins(SbtPlugin) 2 | 3 | name := "sbt-scala-module" 4 | organization := "org.scala-lang.modules" 5 | homepage := Some(url("https://github.com/scala/sbt-scala-module")) 6 | licenses := Seq(("Apache-2.0", url("https://www.apache.org/licenses/LICENSE-2.0"))) 7 | developers := List(Developer("", "", "", url("https://scala-lang.org"))) 8 | 9 | addSbtPlugin("com.github.sbt" % "sbt-osgi" % "0.10.0") 10 | addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.10.0") 11 | addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.11.1") // set version, scmInfo, publishing settings 12 | addSbtPlugin("ch.epfl.scala" % "sbt-version-policy" % "3.2.1") // brings in MiMa 13 | -------------------------------------------------------------------------------- /project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version=1.11.1 2 | -------------------------------------------------------------------------------- /project/plugins.sbt: -------------------------------------------------------------------------------- 1 | addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.11.1") 2 | -------------------------------------------------------------------------------- /src/main/scala/ScalaModulePlugin.scala: -------------------------------------------------------------------------------- 1 | package com.lightbend.tools.scalamoduleplugin 2 | 3 | import com.github.sbt.osgi.{OsgiKeys, SbtOsgi} 4 | import de.heikoseeberger.sbtheader.HeaderPlugin.autoImport.{HeaderLicense, headerLicense} 5 | import sbt.Keys._ 6 | import sbt.{Def, _} 7 | import sbtdynver.DynVerPlugin 8 | import sbtdynver.DynVerPlugin.autoImport.dynverGitDescribeOutput 9 | import sbtversionpolicy.SbtVersionPolicyPlugin.autoImport.{Compatibility, versionPolicyCheck, versionPolicyIgnoredInternalDependencyVersions, versionPolicyIntention} 10 | 11 | object ScalaModulePlugin extends AutoPlugin { 12 | object autoImport { 13 | val scalaModuleRepoName = settingKey[String]("The name of the repository under github.com/scala/.") 14 | val scalaModuleAutomaticModuleName = settingKey[Option[String]]("Automatic-Module-Name setting for manifest") 15 | @deprecated("Previous version is now automatically computed by sbt-version-policy. Setting this key has no effect", "2.4.0") 16 | val scalaModuleMimaPreviousVersion = settingKey[Option[String]]("The version of this module to compare against when running MiMa.") 17 | val scalaModuleEnableOptimizerInlineFrom = settingKey[String]("The value passed to -opt-inline-from by `enableOptimizer` on 2.13 and higher.") 18 | } 19 | import autoImport._ 20 | 21 | // depend on DynVerPlugin to allow modifying dynverGitDescribeOutput in buildSettings below 22 | override def requires = DynVerPlugin 23 | 24 | override def trigger = allRequirements 25 | 26 | // Settings in here are implicitly `in ThisBuild` 27 | override def buildSettings: Seq[Setting[_]] = Seq( 28 | scalaModuleEnableOptimizerInlineFrom := "", 29 | 30 | // drop # suffix from tags 31 | dynverGitDescribeOutput ~= (_.map(dv => 32 | dv.copy(ref = sbtdynver.GitRef(dv.ref.value.split('#').head)))), 33 | ) 34 | 35 | // Settings added to the project scope 36 | override def projectSettings: Seq[Setting[_]] = Seq() 37 | 38 | // Global settings 39 | override def globalSettings: Seq[Def.Setting[_]] = Seq( 40 | // Since we use sbt-dynver, see https://github.com/scalacenter/sbt-version-policy#how-to-integrate-with-sbt-dynver 41 | versionPolicyIgnoredInternalDependencyVersions := Some("^\\d+\\.\\d+\\.\\d+\\+\\d+".r) 42 | ) 43 | 44 | /** 45 | * Enable `-opt:l:inline`, `-opt:l:project` or `-optimize`, depending on the Scala version. 46 | * 47 | * Note that the optimizer is only enabled in CI and not during local development. 48 | * Thus, for consistent results, release artifacts must only be built on CI -- 49 | * which is the expected norm for Scala modules, anyway. 50 | */ 51 | lazy val enableOptimizer: Setting[_] = Compile / compile / scalacOptions ++= { 52 | if (insideCI.value) { 53 | val log = sLog.value 54 | val inlineFrom = scalaModuleEnableOptimizerInlineFrom.value 55 | log.info(s"Running in CI, enabling Scala2 optimizer for module: ${name.value} with -opt-inline-from: $inlineFrom") 56 | val Ver = """(\d+)\.(\d+)\.(\d+).*""".r 57 | val Ver(epic, maj, min) = scalaVersion.value 58 | (epic, maj.toInt, min.toInt) match { 59 | case ("2", m, _) if m < 12 => Seq("-optimize") 60 | case ("2", 12, n) if n < 3 => Seq("-opt:l:project") 61 | case ("2", _, _) => Seq("-opt:l:inline", "-opt-inline-from:" + inlineFrom) 62 | case ("3", _, _) => Nil // Optimizer not yet available for Scala3, see https://docs.scala-lang.org/overviews/compiler-options/optimizer.html 63 | } 64 | } else Nil 65 | } 66 | 67 | /** 68 | * To be included in the main sbt project of a Scala module. 69 | */ 70 | lazy val scalaModuleSettings: Seq[Setting[_]] = Seq( 71 | scalaModuleRepoName := name.value, 72 | 73 | organization := "org.scala-lang.modules", 74 | 75 | // don't use for doc scope, scaladoc warnings are not to be reckoned with 76 | Compile / compile / scalacOptions ++= Seq("-feature", "-deprecation", "-unchecked"), 77 | Compile / compile / scalacOptions ++= { 78 | CrossVersion.partialVersion(scalaVersion.value) match { 79 | case Some((2, _)) => Seq("-Xlint") 80 | case _ => Seq.empty 81 | } 82 | }, 83 | 84 | // Generate $name.properties to store our version as well as the scala version used to build 85 | Compile / resourceGenerators += Def.task { 86 | val props = new java.util.Properties 87 | props.put("version.number", version.value) 88 | props.put("scala.version.number", scalaVersion.value) 89 | props.put("scala.binary.version.number", scalaBinaryVersion.value) 90 | val file = (Compile / resourceManaged).value / s"${name.value}.properties" 91 | IO.write(props, null, file) 92 | Seq(file) 93 | }.taskValue, 94 | 95 | // note that scalaModuleAutomaticModuleName has no default value, forcing 96 | // clients of this plugin to explicitly set it 97 | Compile / packageBin / packageOptions ++= 98 | (scalaModuleAutomaticModuleName.value match { 99 | case Some(name) => Seq(Package.ManifestAttributes("Automatic-Module-Name" -> name)) 100 | case None => Seq() 101 | }), 102 | 103 | Compile / packageBin / mappings += { 104 | (baseDirectory.value / s"${name.value}.properties") -> s"${name.value}.properties" 105 | }, 106 | 107 | // needed to fix classloader issues (see scala/scala-xml#20) 108 | // essentially, the problem is that the run-time bootclasspath leaks into the compilation classpath, 109 | // so that scalac see classes used to run it, as classes used to compile against... 110 | // forking uses a minimal classpath, so this craziness is avoided 111 | // alternatively, manage the scala instance as shown at the end of this file (commented) 112 | Test / fork := true, 113 | 114 | headerLicense := Some(HeaderLicense.Custom( 115 | s"""|Scala (https://www.scala-lang.org) 116 | | 117 | |Copyright EPFL and Lightbend, Inc. dba Akka 118 | | 119 | |Licensed under Apache License 2.0 120 | |(http://www.apache.org/licenses/LICENSE-2.0). 121 | | 122 | |See the NOTICE file distributed with this work for 123 | |additional information regarding copyright ownership. 124 | |""".stripMargin)), 125 | 126 | scmInfo := Some(ScmInfo(url(s"https://github.com/scala/${scalaModuleRepoName.value}"),s"scm:git:git://github.com/scala/${scalaModuleRepoName.value}.git")), 127 | homepage := Some(url("http://www.scala-lang.org/")), 128 | organizationHomepage := Some(url("http://www.scala-lang.org/")), 129 | licenses := Seq("Apache-2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0")), 130 | startYear := Some(2002), 131 | pomIncludeRepository := { _ => false }, 132 | pomExtra := ( 133 | 134 | GitHub 135 | https://github.com/scala/{scalaModuleRepoName.value}/issues 136 | 137 | 138 | 139 | lamp 140 | LAMP/EPFL 141 | 142 | 143 | Akka 144 | Lightbend, Inc. dba Akka 145 | 146 | 147 | ) 148 | ) ++ mimaSettings 149 | 150 | @deprecated("use scalaModuleOsgiSettings instead", "2.2.0") 151 | lazy val scalaModuleSettingsJVM: Seq[Setting[_]] = scalaModuleOsgiSettings 152 | 153 | // enables the SbtOsgi plugin and defines some default settings 154 | lazy val scalaModuleOsgiSettings: Seq[Setting[_]] = SbtOsgi.projectSettings ++ SbtOsgi.autoImport.osgiSettings ++ Seq( 155 | OsgiKeys.bundleSymbolicName := s"${organization.value}.${name.value}", 156 | OsgiKeys.bundleVersion := osgiVersion.value, 157 | 158 | // Sources should also have a nice MANIFEST file 159 | packageSrc / packageOptions := Seq(Package.ManifestAttributes( 160 | ("Bundle-SymbolicName", s"${organization.value}.${name.value}.source"), 161 | ("Bundle-Name", s"${name.value} sources"), 162 | ("Bundle-Version", osgiVersion.value), 163 | ("Eclipse-SourceBundle", s"""${organization.value}.${name.value};version="${osgiVersion.value}";roots:="."""") 164 | )) 165 | ) 166 | 167 | // a setting-transform to turn the regular version into something osgi can deal with 168 | private val osgiVersion = version(_.replace('-', '.')) 169 | 170 | // Internal task keys for the versionPolicy settings 171 | private val runVersionPolicyCheckIfEnabled = taskKey[Unit]("Run versionPolicyCheck if versionPolicyIntention is not set to Compatibility.None.") 172 | 173 | private lazy val mimaSettings: Seq[Setting[_]] = Seq( 174 | versionPolicyIntention := Compatibility.None, 175 | 176 | runVersionPolicyCheckIfEnabled := Def.taskDyn({ 177 | if (versionPolicyIntention.value != Compatibility.None) Def.task { versionPolicyCheck.value } 178 | else Def.task { 179 | streams.value.log.warn("versionPolicyCheck will NOT run because versionPolicyIntention is set to Compatibility.None.") 180 | } 181 | }).value, 182 | 183 | Test / test := { 184 | runVersionPolicyCheckIfEnabled.value 185 | (Test / test).value 186 | } 187 | ) 188 | } 189 | 190 | 191 | // ALTERNATIVE to fork in test for fixing classpath issues noted above: 192 | // manage the Scala instance ourselves to exclude the published scala-xml (scala-compiler depends on it) 193 | // since this dependency hides the classes we're testing 194 | // managedScalaInstance := false 195 | // 196 | // ivyConfigurations += Configurations.ScalaTool 197 | // 198 | // libraryDependencies ++= Seq( 199 | // "org.scala-lang" % "scala-library" % scalaVersion.value, 200 | // ("org.scala-lang" % "scala-compiler" % scalaVersion.value % "scala-tool").exclude("org.scala-lang.modules", s"scala-xml_${scalaBinaryVersion.value}") 201 | // ) 202 | --------------------------------------------------------------------------------