Skip to content

Broken generation of API documentation using scaladoc #21821

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.

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

Closed
WojciechMazur opened this issue Oct 21, 2024 · 0 comments · Fixed by #21837
Closed

Broken generation of API documentation using scaladoc #21821

WojciechMazur opened this issue Oct 21, 2024 · 0 comments · Fixed by #21837

Comments

@WojciechMazur
Copy link
Contributor

The changes to versioning in the build affected the scaladoc/generateStableScala3Documentation task.
It now silently fails by not emitting index.html
The issue can be noticed in the logs of this task:

scaladoc will ignore following non-existent paths: 
  out/bootstrap/scala2-library-bootstrapped/scala-3.6.1-bin-SNAPSHOT-nonbootstrapped/classes, 
  out/bootstrap/scala3-library-bootstrapped/scala-3.6.1-bin-SNAPSHOT-nonbootstrapped/classes,
  tmp/interfaces/target/classes, 
  out/bootstrap/tasty-core-bootstrapped/scala-3.6.1-bin-SNAPSHOT-nonbootstrapped/classes

tmp/interfaces/target/classes is a hard-coded path, it should be removed as we're not emitting API for compiler-interfaces

The 3 remaining paths are incorrect in such a way that when using baseVersion = "3.6.1" the non-boostrapepd output files are present in the 3.6.1-RC1-bin-... directories instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant