diff --git a/docs/modules/ROOT/pages/Scala_Build_Examples.adoc b/docs/modules/ROOT/pages/Scala_Build_Examples.adoc index c5acf024c64..da0661600c5 100644 --- a/docs/modules/ROOT/pages/Scala_Build_Examples.adoc +++ b/docs/modules/ROOT/pages/Scala_Build_Examples.adoc @@ -9,14 +9,14 @@ realistic Scala codebases: cross-building, testing, and publishing them. Many of the APIs covered here are listed in the Scaladoc: -* {mill-doc-url}/api/latest/mill/scalalib/ScalaModule.html[mill.scalalib.ScalaModule] -* {mill-doc-url}/api/latest/mill/main/RootModule.html[mill.scalalib.RootModule] -* {mill-doc-url}/api/latest/mill/scalalib/TestModule$.html[mill.scalalib.TestModule] -* {mill-doc-url}/api/latest/mill/scalalib/PublishModule.html[mill.scalalib.PublishModule] -* {mill-doc-url}/api/latest/mill/scalalib/CrossScalaModule.html[mill.scalalib.CrossScalaModule] -* {mill-doc-url}/api/latest/mill/scalalib/SbtModule.html[mill.scalalib.SbtModule] -* {mill-doc-url}/api/latest/mill/scalalib/CrossSbtModule.html[mill.scalalib.CrossSbtModule] -* {mill-doc-url}/api/latest/mill/scalalib/JavaModule.html[mill.scalalib.JavaModule] +* {mill-doc-url}/api/latest/mill/scalalib/ScalaModule.html[`mill.scalalib.ScalaModule`] +* {mill-doc-url}/api/latest/mill/main/RootModule.html[`mill.scalalib.RootModule`] +* {mill-doc-url}/api/latest/mill/scalalib/TestModule$.html[`mill.scalalib.TestModule`] +* {mill-doc-url}/api/latest/mill/scalalib/PublishModule.html[`mill.scalalib.PublishModule`] +* {mill-doc-url}/api/latest/mill/scalalib/CrossScalaModule.html[`mill.scalalib.CrossScalaModule`] +* {mill-doc-url}/api/latest/mill/scalalib/SbtModule.html[`mill.scalalib.SbtModule`] +* {mill-doc-url}/api/latest/mill/scalalib/CrossSbtModule.html[`mill.scalalib.CrossSbtModule`] +* {mill-doc-url}/api/latest/mill/scalalib/JavaModule.html[`mill.scalalib.JavaModule`] == Common Configuration Overrides @@ -66,31 +66,12 @@ integration tests and examples: === Acyclic -* {mill-github-url}/blob/main/integration/thirdparty/local/resources/acyclic/build.sc#L1[Mill Build] +include::example/thirdparty/acyclic.adoc[] -A small single-module cross-build, with few sources, minimal dependencies, and -wired up for publishing to Maven Central. +=== Fansi -=== Jawn +include::example/thirdparty/fansi.adoc[] -* {mill-github-url}/blob/main/integration/thirdparty/local/resources/jawn/build.sc#L1[Mill Build] +=== JimFS -A collection of relatively small modules, all cross-built across the same few -versions of Scala. - -=== Upickle - -* {mill-github-url}/blob/main/integration/thirdparty/local/resources/upickle/build.sc#L1[Mill Build] - -A single cross-platform Scala.js/Scala-JVM module cross-built against multiple -versions of Scala, including the setup necessary for publishing to Maven Central. - -=== Ammonite - -* {mill-github-url}/blob/main/integration/thirdparty/local/resources/ammonite/build.sc#L1[Mill Build] - -A relatively complex build with numerous submodules, some cross-built across -Scala major versions while others are cross-built against Scala minor versions. - -Also demonstrates how to pass one module's compiled artifacts to the -`run`/`test` commands of another, via their `forkEnv`. +include::example/thirdparty/jimfs.adoc[] diff --git a/example/thirdparty/acyclic/build.sc b/example/thirdparty/acyclic/build.sc index b362bd89f3f..0c800285a37 100644 --- a/example/thirdparty/acyclic/build.sc +++ b/example/thirdparty/acyclic/build.sc @@ -39,6 +39,8 @@ trait AcyclicModule extends CrossScalaModule with PublishModule { // Acyclic is an example of a very small project that is a Scala compiler // plugin. It is cross-built against all point versions of Scala from 2.11.12 // to 2.13.10, and has a dependency on the `org.scala-lang:scala-compiler` +// +// Project home: https://github.com/com-lihaoyi/acyclic /** Usage diff --git a/example/thirdparty/fansi/build.sc b/example/thirdparty/fansi/build.sc index e2ec24d46e2..179603b5dbb 100644 --- a/example/thirdparty/fansi/build.sc +++ b/example/thirdparty/fansi/build.sc @@ -46,9 +46,12 @@ object fansi extends Module { // Fansi is an example of a small library that is cross built against every // minor version of Scala (including Scala 3.x) and every platform: JVM, JS, -// and Native. Both the library and the test suite are duplicated across all +// and Native. +// Both the library and the test suite are duplicated across all // entries in the {version}x{platform} matrix, and you can select which one you // want to compile, test, or publish +// +// Project home: https://github.com/com-lihaoyi/fansi /** Usage diff --git a/example/thirdparty/jimfs/build.sc b/example/thirdparty/jimfs/build.sc index f7b4f970032..980a997cbe8 100644 --- a/example/thirdparty/jimfs/build.sc +++ b/example/thirdparty/jimfs/build.sc @@ -39,6 +39,8 @@ object jimfs extends PublishModule with MavenModule{ } // JimFS is a small Java library +// +// Project home: https://github.com/google/jimfs /** Usage