Skip to content

Skip doc generation for nonbootstrapped projects#25705

Merged
tanishiking merged 1 commit intoscala:mainfrom
tanishiking:suppress-docgen-nonbootstrapped
Apr 4, 2026
Merged

Skip doc generation for nonbootstrapped projects#25705
tanishiking merged 1 commit intoscala:mainfrom
tanishiking:suppress-docgen-nonbootstrapped

Conversation

@tanishiking
Copy link
Copy Markdown
Member

fix #25704

Previously, running sbt publishLocal causes scaladoc generation for scala-library-nonbootstrapped and scala3-library-nonbootstrapped.

These two projects don't explicitly set Compile / packageDoc / publishArtifact := false, and therefore sbt defaults to generate doc jars on publishLocal.

However, IIUC, there's no point of generating scaladoc for nonbootstrapped projects because these artifacts are only published locally for bootstrapping (and local development), and the bootstrapped projects reference packageBin outputs and don't care about packageDoc. In fact, other nonbootstrapped projects like scala3-compiler-nonbootstrapped and tasty-core-nonbootstrapped already set packageDoc / publishArtifact := false.

In my local environemnt, clean build with publishLocal, previously took 230s, and not it took around 90s.

How much have you relied on LLM-based tools in this contribution?

not used

How was the solution tested?

Run sbt publishLocal locally. I'd like to confirm my assumption that disable doc publishing for nonbootstrapped project is safe.

Additional notes

fix scala#25704

Previously, running `sbt publishLocal` causes scaladoc generation for `scala-library-nonbootstrapped` and `scala3-library-nonbootstrapped`.

These two projects don't explicitly set `Compile / packageDoc / publishArtifact := false`, and therefore sbt defaults to generate doc jars on `publishLocal`.

However, IIUC, there's no point of generating scaladoc for nonbootstrapped projects because these artifacts are only published locally for bootstrapping (and local development), and the bootstrapped projects reference packageBin outputs and don't care about packageDoc.
In fact, other nonbootstrapped projects like `scala3-compiler-nonbootstrapped` and `tasty-core-nonbootstrapped` already set `packageDoc / publishArtifact := false`.

In my local environemnt, clean build with `publishLocal`, previously took 230s, and not it took around 90s.
Copy link
Copy Markdown
Contributor

@tgodzik tgodzik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense! I had claude on it at some point and the same was suggested

@tanishiking tanishiking merged commit 2a79b8e into scala:main Apr 4, 2026
64 checks passed
@tanishiking tanishiking deleted the suppress-docgen-nonbootstrapped branch April 4, 2026 04:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Skip doc generation for nonbootstrapped library projects

2 participants