Backport "Unify generation of Scala 3 API and Reference documentations" to 3.8.0 #24400
Conversation
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
This PR does unify how snapshot and stable scaladoc artifacts are published: - `docs/sidebar.yml` now contains only entries visible for stable releases - `docs/sidebar.nightly.template.yml` contains entries specific for Snapshot builds (contributing guide, blog posted at https://dotty.epfl.ch/) - it does not contain `reference` subsection entries - this part is now generated when executing `generateScalaDocumentation` task. It emits a patch to `docs/sidebar.yml` containg combined inputs from both files - `project/resources/referenceReplacements/_layouts/static-site-main.html` was removed, instead we now inject the warning only when building snapshot docs using `generateScalaDocumentation` - `project/resources/referenceReplacements/sidebar.yml` is removed, we would no longer need to keep 2 files in sync - `generateStableScala3Documentation` no longer uses calculated paths to obtain compilation outputs - it was only needed in the past to allow for generation of new scaladoc for older compiler/library [Cherry-picked 9ba8854]
Base automatically changed from release-3.8.0_backport-24307 to release-3.8.0 November 12, 2025 20:03
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.
Backports #23606 to the 3.8.0-RC1.
PR submitted by the release tooling.
[skip ci]