A Scalac compiler plugin to support Mill modules.
The Mill build tool module structure is highly tied to the organizational structure of the Scala programming language.
Project modules are modelled as Scala objects, Module targets are modelled as Scala defs.
Mill targets are also modelled as free applicatives, which among other things makes the Mill task graph introspectable. To hide some boilerplate code needed to nicely write tasks like defs, Mill uses some Scala macros and a Scalac compiler plugin.
In this project, you’ll find the compiler plugin and some shared code.
Artifacts of this project are released to Maven Central.
def ivyDeps = Agg(
ivy"com.lihaoyi::mill-moduledefs:0.10.9"
)
// Enable the plugin in the Scala compiler
def scalacPluginIvyDeps = Agg(
ivy"com.lihaoyi:::scalac-mill-moduledefs-plugin:0.10.9"
)This project contains two modules:
-
moduledefs- Some shared code to be used in the Mill classpath. TheartifactNameismill-moduledefs. -
moduledefs/plugin- A Scalac compiler plugin to be used when compiling Mill projects. TheartifactNameisscalac-mill-moduledefs-plugin.
This code is expected to change rarely.
It should be especially kept stable within the same Mill major version.
Publishing is automated via GitHub Actions and implemented in the publishToSonatype command.
def publishToSonatype(
sonatypeCreds: String,
gpgArgs: String = PublishModule.defaultGpgArgs.mkString(","),
dryRun: Boolean = false,
artifactsFile: Option[String] = None
): Command[Unit]You need to update the version manually, before creatign the git tag!
All git tags are automatically published. The tag should reflect the version number.
The most frequently expected changes are releases for newer Scala version. This is especially needed, as compiler plugins are tied to the exact Scala compiler version.
Hence, this build aims to be flexible enough, to release an already tagged version for newer Scalac releases after the fact.
As an example, to release an already published version 0.10.9 for a new Scala version 2.13.10, follow these steps:
-
Create a branch
release-0.10.9from the git tag0.10.9. -
Add the new Scala version to the build setup. Make sure you don’t change the actual code, so it stays compatible to the original tag.
-
Add a file
PUBLISH_ONLYcontaining a selector for the artifacts to publish. If you need more than one selector, place each on a new line.Example filePUBLISH_ONLYmoduledefs.plugin[2.13.10].publishArtifacts
-
Commit your changes.
-
Tag your commit with
0.10.9-for-2.13.10. This will trigger thepublish-sonatypeworkflow in GHA. -
If appropriate, update the Readme/Changelog in the
mainbranch.
This project is published under the MIT License.
First stable release from this repository. No feature additions and removals since release 0.10.8 from the Mill repository.
-
2023-06-03: Published for Scala 2.13.11
-
2023-09-07: Published for Scala 2.13.12
-
2024-02-27: Published for Scala 2.13.13
Older versions of this project were developed in the Mill git repository and were packaged as ordinary Scala artifact mill-moduledefs (without the full Scala version suffix). Refer to issue #2035, to learn why we split the projects.
