Speedup bisection builds by skipping generation of scaladoc #18157
Conversation
In case of bisecting that would not work, becouse this new task |
Makes sense! |
project/scripts/bisect.scala
Outdated
| @@ -238,6 +238,7 @@ class CommitBisect(validationScript: File, shouldFail: Boolean, bootstrapped: Bo | |||
| val bisectRunScript = s""" | |||
| |scalaVersion=$$(sbt "print ${scala3CompilerProject}/version" | tail -n1) | |||
| |rm -r out | |||
| |export BISECTBUILD=yes | |||
| |sbt "clean; ${scala3Project}/publishLocal" | |||
There was a problem hiding this comment.
| |sbt "clean; ${scala3Project}/publishLocal" | |
| |sbt "clean; set Compile / doc / skip := true; set Compile/ doc / sources := Nil; ${scala3Project}/publishLocal" |
I think this single line change should be equivalent to all the other changes from this PR and it should speed up also builds of historical commits
There was a problem hiding this comment.
Not really, the global scope definition would not propagate to the projects, so these would have any effect. We could use set every x but this one does not support scopes, instead it would apply value to every task with given name. We could use internals to properly set correct values, but that's the overkill.
However, we can use comination of 2 more specific commands to get the expected effect:
set scaladoc/Compile/resourceGenerators := (ThisBuild/Compile/resourceGenerators).value- to remove custom resourceGenerators requiring compilation and linking scaladoc static resources using Scala.js, we still want to keep the default onesset every doc := new File("unused")- overwrite alldoctasks to no-op (seems to be unharmfull, even though we use non-exisitng file)
…lish times by 50%
WojciechMazur
force-pushed
the
build/bisect-builds
branch
from
60c8ed1 to
ee76224
Compare
| @@ -238,7 +238,7 @@ class CommitBisect(validationScript: File, shouldFail: Boolean, bootstrapped: Bo | |||
| val bisectRunScript = s""" | |||
| |scalaVersion=$$(sbt "print ${scala3CompilerProject}/version" | tail -n1) | |||
| |rm -r out | |||
| |sbt "clean; ${scala3Project}/publishLocal" | |||
| |sbt "clean; set every doc := new File(\"unused\"); set scaladoc/Compile/resourceGenerators := (\`${scala3Project}\`/Compile/resourceGenerators).value; ${scala3Project}/publishLocal" | |||
There was a problem hiding this comment.
Are backticks required around the first occurrence of the project name but not the second one?
There was a problem hiding this comment.
Yes, in ${scala3Project}/publishLocal we get special handling provided by sbt when running commands, however, in := {...} part we're in the scope which is not covered by special handling and we need to refer to actual symbols defined in the code. It's quite a common problem that we need to use different syntax in set and different syntax in regular commands
The bisection script had a bug introduced in #18157 that was failing at runtime when executing bisect
Adds special mode for sbt builds enabled with
BISECTBUILD=yesenv variables. Under this mode scaladoc and static resources are not generated, though allowing to speedup local publishing by up to 50% (92s vs 189s previously).Flag would be used when bisecting projects.