Skip to content

Setup doc / scalaInstance instance to be used when building docs. #24433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+48 −10
Open

Setup doc / scalaInstance instance to be used when building docs. #24433

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfb93fe
Setup `doc / scalaInstance` instance to be used when building docs.
WojciechMazur Nov 14, 2025
cd8c886
Disable generation of API docs in scala-library-bootstrapped - it's s…
WojciechMazur Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 48 additions & 10 deletions project/Build.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ object Build {
import java.text._
val dateFormat = new SimpleDateFormat("yyyyMMdd-HHmmss")
dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"))

val fileName = "compiler.properties"
val contents = Def.setting {
s"""version.number=${version.value}
Expand Down Expand Up @@ -516,6 +516,34 @@ object Build {
enableBspAllProjectsFile.exists()
}

// Setups up doc / scalaInstance to use in the bootstrapped projects instead of the default one
lazy val scaladocDerivedInstanceSettings = Def.settings(
// We cannot include scaladoc in the regular `scalaInstance` task because
// it's a bootstrapped-only project, so we would run into a loop since we
// need the output of that task to compile scaladoc. But we can include it
// in the `scalaInstance` of the `doc` task which allows us to run
// `scala3-library-bootstrapped/doc` for example.
doc / scalaInstance := {
val externalDeps = (LocalProject("scaladoc-new") / Compile / externalDependencyClasspath).value.map(_.data)
val scalaDoc = (LocalProject("scaladoc-new") / Compile / packageBin).value
val docJars = Array(scalaDoc) ++ externalDeps

val base = scalaInstance.value
val docScalaInstance = Defaults.makeScalaInstance(
version = base.version,
libraryJars = base.libraryJars,
allCompilerJars = base.compilerJars,
allDocJars = docJars,
state.value,
scalaInstanceTopLoader.value
)
// assert that sbt reuses the same compiler class loader
assert(docScalaInstance.loaderCompilerOnly == base.loaderCompilerOnly)
docScalaInstance
},
Compile / doc / scalacOptions ++= scalacOptionsDocSettings(),
)

// Settings used when compiling dotty with a non-bootstrapped dotty
lazy val commonBootstrappedSettings = commonDottySettings ++ Seq(
// To enable support of scaladoc and language-server projects you need to change this to true
Expand Down Expand Up @@ -1647,7 +1675,7 @@ object Build {
),
// Packaging configuration of `scala3-sbt-bridge`
Compile / packageBin / publishArtifact := true,
Compile / packageDoc / publishArtifact := false,
Compile / packageDoc / publishArtifact := true,
Compile / packageSrc / publishArtifact := true,
// Only publish compilation artifacts, no test artifacts
Test / publishArtifact := false,
Expand Down Expand Up @@ -1679,6 +1707,7 @@ object Build {
scalaInstanceTopLoader.value
)
},
scaladocDerivedInstanceSettings,
scalaCompilerBridgeBinaryJar := {
Some((`scala3-sbt-bridge-nonbootstrapped` / Compile / packageBin).value)
},
Expand Down Expand Up @@ -1709,7 +1738,7 @@ object Build {
Compile / scalacOptions ++= Seq("--java-output-version", Versions.minimumJVMVersion),
// Packaging configuration of `scala3-staging`
Compile / packageBin / publishArtifact := true,
Compile / packageDoc / publishArtifact := false,
Compile / packageDoc / publishArtifact := true,
Compile / packageSrc / publishArtifact := true,
// Only publish compilation artifacts, no test artifacts
Test / publishArtifact := false,
Expand Down Expand Up @@ -1737,6 +1766,7 @@ object Build {
scalaInstanceTopLoader.value
)
},
scaladocDerivedInstanceSettings,
scalaCompilerBridgeBinaryJar := {
Some((`scala3-sbt-bridge-nonbootstrapped` / Compile / packageBin).value)
},
Expand Down Expand Up @@ -1767,7 +1797,7 @@ object Build {
Compile / scalacOptions ++= Seq("--java-output-version", Versions.minimumJVMVersion),
// Packaging configuration of `scala3-staging`
Compile / packageBin / publishArtifact := true,
Compile / packageDoc / publishArtifact := false,
Compile / packageDoc / publishArtifact := true,
Compile / packageSrc / publishArtifact := true,
// Only publish compilation artifacts, no test artifacts
Test / publishArtifact := false,
Expand Down Expand Up @@ -1795,6 +1825,7 @@ object Build {
scalaInstanceTopLoader.value
)
},
scaladocDerivedInstanceSettings,
scalaCompilerBridgeBinaryJar := {
Some((`scala3-sbt-bridge-nonbootstrapped` / Compile / packageBin).value)
},
Expand Down Expand Up @@ -1823,7 +1854,7 @@ object Build {
Compile / scalacOptions ++= Seq("--java-output-version", Versions.minimumJVMVersion),
// Packaging configuration of `scala3-staging`
Compile / packageBin / publishArtifact := true,
Compile / packageDoc / publishArtifact := false,
Compile / packageDoc / publishArtifact := true,
Compile / packageSrc / publishArtifact := true,
// Only publish compilation artifacts, no test artifacts
Test / publishArtifact := false,
Expand Down Expand Up @@ -1860,6 +1891,7 @@ object Build {
scalaInstanceTopLoader.value
)
},
scaladocDerivedInstanceSettings,
scalaCompilerBridgeBinaryJar := {
Some((`scala3-sbt-bridge-nonbootstrapped` / Compile / packageBin).value)
},
Expand Down Expand Up @@ -1994,6 +2026,7 @@ object Build {
lazy val `scala-library-bootstrapped` = project.in(file("library"))
.enablePlugins(ScalaLibraryPlugin)
.settings(publishSettings)
.settings(disableDocSetting) // TODO now produces empty JAR to satisfy Sonatype, see https://github.com/scala/scala3/issues/24434
.settings(
name := "scala-library-bootstrapped",
moduleName := "scala-library",
Expand Down Expand Up @@ -2025,7 +2058,7 @@ object Build {
Compile / scalacOptions ++= Seq("--java-output-version", Versions.minimumJVMVersion),
// Packaging configuration of the stdlib
Compile / packageBin / publishArtifact := true,
Compile / packageDoc / publishArtifact := false,
Compile / packageDoc / publishArtifact := true,
Compile / packageSrc / publishArtifact := true,
// Only publish compilation artifacts, no test artifacts
Test / publishArtifact := false,
Expand Down Expand Up @@ -2058,6 +2091,7 @@ object Build {
scalaInstanceTopLoader.value
)
},
scaladocDerivedInstanceSettings,
scalaCompilerBridgeBinaryJar := {
Some((`scala3-sbt-bridge-nonbootstrapped` / Compile / packageBin).value)
},
Expand Down Expand Up @@ -2157,7 +2191,7 @@ object Build {
Compile / scalacOptions += "-scalajs",
// Packaging configuration of the stdlib
Compile / packageBin / publishArtifact := true,
Compile / packageDoc / publishArtifact := false,
Compile / packageDoc / publishArtifact := true,
Compile / packageSrc / publishArtifact := true,
// Only publish compilation artifacts, no test artifacts
Test / publishArtifact := false,
Expand Down Expand Up @@ -2218,6 +2252,7 @@ object Build {
scalaInstanceTopLoader.value
)
},
scaladocDerivedInstanceSettings,
scalaCompilerBridgeBinaryJar := {
Some((`scala3-sbt-bridge-nonbootstrapped` / Compile / packageBin).value)
},
Expand Down Expand Up @@ -2381,7 +2416,7 @@ object Build {
),
// Packaging configuration of the stdlib
Compile / packageBin / publishArtifact := true,
Compile / packageDoc / publishArtifact := false,
Compile / packageDoc / publishArtifact := true,
Compile / packageSrc / publishArtifact := true,
// Only publish compilation artifacts, no test artifacts
Test / publishArtifact := false,
Expand Down Expand Up @@ -2412,6 +2447,7 @@ object Build {
scalaInstanceTopLoader.value
)
},
scaladocDerivedInstanceSettings,
scalaCompilerBridgeBinaryJar := {
Some((`scala3-sbt-bridge-nonbootstrapped` / Compile / packageBin).value)
},
Expand Down Expand Up @@ -2617,7 +2653,7 @@ object Build {
packageOptions += ManifestAttributes(("Git-Hash", VersionUtil.gitHash)), // Used by the REPL
// Packaging configuration of the stdlib
Compile / packageBin / publishArtifact := true,
Compile / packageDoc / publishArtifact := false,
Compile / packageDoc / publishArtifact := true,
Compile / packageSrc / publishArtifact := true,
// Only publish compilation artifacts, no test artifacts
Test / publishArtifact := false,
Expand Down Expand Up @@ -2651,6 +2687,7 @@ object Build {
scalaInstanceTopLoader.value
)
},
scaladocDerivedInstanceSettings,
scalaCompilerBridgeBinaryJar := {
Some((`scala3-sbt-bridge-nonbootstrapped` / Compile / packageBin).value)
},
Expand Down Expand Up @@ -2771,7 +2808,7 @@ object Build {
Compile / scalacOptions ++= Seq("--java-output-version", Versions.minimumJVMVersion),
// Packaging configuration of the stdlib
Compile / packageBin / publishArtifact := true,
Compile / packageDoc / publishArtifact := false,
Compile / packageDoc / publishArtifact := true,
Compile / packageSrc / publishArtifact := true,
// Only publish compilation artifacts, no test artifacts
Test / publishArtifact := false,
Expand All @@ -2784,6 +2821,7 @@ object Build {
BuildInfoPlugin.buildInfoScopedSettings(Compile),
BuildInfoPlugin.buildInfoDefaultSettings,
// Configure to use the non-bootstrapped compiler
scaladocDerivedInstanceSettings,
scalaInstance := {
val externalCompilerDeps = (`scala3-compiler-nonbootstrapped` / Compile / externalDependencyClasspath).value.map(_.data).toSet

Expand Down
Loading