Serialize scaladoc during publish and fix opentelemetry doc links#159
Merged
Conversation
ci-release documents every published cell in parallel in one JVM, which intermittently trips a scaladoc SignatureBuilder NPE (dottydoc is not thread-safe). Tag every doc task and cap the tag at 1 to serialize it. Also drop two unresolvable [[OpenTelemetry]] doc links, and add opentelemetry/doc to docAll so the docs gate covers that module.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
publishjob (sbt ci-release) fails with a scaladoc crash while documenting theclientKyo(Scala 3.8.4) cell:The identical
clientKyo3_8_4/doctask succeeds in thedocsjob of the same run and locally. dottydoc is not thread-safe, andci-releaserunspackageDocfor every published cell in parallel in one JVM (far more than thedocsgate'sdocAll), intermittently tripping the race.Changes
Compile / doctask and cap the tag at 1 concurrent, serializing scaladoc during publish.[[OpenTelemetry]]doc links (external type dottydoc can't resolve) in favor of monospace.opentelemetry/doctodocAllso the docs gate covers that module (it previously slipped past the gate).Verification
sbt docAllpasses with noCouldn't resolve/ warning lines.