Skip to content

fix: Don't compile docs if there is no need #3503

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 19, 2025
Merged

fix: Don't compile docs if there is no need #3503

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
511084b
fix: Don't compile docs if there is no need
ghostbuster91 Feb 17, 2025
917fcdb
Add testcase for publishing without docs
ghostbuster91 Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions modules/cli/src/main/scala/scala/cli/commands/publish/Publish.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,8 +230,8 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
).orExit(logger)
val threads = BuildThreads.create()

val compilerMaker = options.shared.compilerMaker(threads)
val docCompilerMaker = options.shared.compilerMaker(threads, scaladoc = true)
val compilerMaker = options.shared.compilerMaker(threads)
val docCompilerMakerOpt = options.sharedPublish.docCompilerMakerOpt

val cross = options.compileCross.cross.getOrElse(false)

Expand All @@ -256,7 +256,7 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
logger,
initialBuildOptions,
compilerMaker,
docCompilerMaker,
docCompilerMakerOpt,
cross,
workingDir,
ivy2HomeOpt,
Expand All @@ -278,7 +278,7 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
logger: Logger,
initialBuildOptions: BuildOptions,
compilerMaker: ScalaCompilerMaker,
docCompilerMaker: ScalaCompilerMaker,
docCompilerMaker: Option[ScalaCompilerMaker],
cross: Boolean,
workingDir: => os.Path,
ivy2HomeOpt: Option[os.Path],
Expand All @@ -299,7 +299,7 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
inputs,
initialBuildOptions,
compilerMaker,
Some(docCompilerMaker),
docCompilerMaker,
logger,
crossBuilds = cross,
buildTests = false,
Expand Down Expand Up @@ -333,7 +333,7 @@ object Publish extends ScalaCommand[PublishOptions] with BuildCommandHelpers {
inputs,
initialBuildOptions,
compilerMaker,
Some(docCompilerMaker),
docCompilerMaker,
logger,
crossBuilds = cross,
buildTests = false,
Expand Down
6 changes: 3 additions & 3 deletions modules/cli/src/main/scala/scala/cli/commands/publish/PublishLocal.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ object PublishLocal extends ScalaCommand[PublishLocalOptions] {
).orExit(logger)
val threads = BuildThreads.create()

val compilerMaker = options.shared.compilerMaker(threads)
val docCompilerMaker = options.shared.compilerMaker(threads, scaladoc = true)
val compilerMaker = options.shared.compilerMaker(threads)
val docCompilerMakerOpt = options.sharedPublish.docCompilerMakerOpt

val cross = options.compileCross.cross.getOrElse(false)

Expand All @@ -75,7 +75,7 @@ object PublishLocal extends ScalaCommand[PublishLocalOptions] {
logger,
initialBuildOptions,
compilerMaker,
docCompilerMaker,
docCompilerMakerOpt,
cross,
workingDir,
ivy2HomeOpt,
Expand Down
12 changes: 10 additions & 2 deletions modules/cli/src/main/scala/scala/cli/commands/publish/SharedPublishOptions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package scala.cli.commands.publish

import caseapp.*

import scala.build.compiler.{ScalaCompilerMaker, SimpleScalaCompilerMaker}
import scala.cli.commands.shared.HelpGroup
import scala.cli.commands.tags

Expand Down Expand Up @@ -85,8 +86,15 @@ final case class SharedPublishOptions(
@HelpMessage("Proceed as if publishing, but do not upload / write artifacts to the remote repository")
@Tag(tags.implementation)
dummy: Boolean = false
)
// format: on
){
// format: on

def docCompilerMakerOpt: Option[ScalaCompilerMaker] =
if (doc.contains(false)) // true by default
None
else
Some(SimpleScalaCompilerMaker("java", Nil, scaladoc = true))
}

object SharedPublishOptions {
implicit lazy val parser: Parser[SharedPublishOptions] = Parser.derive
Expand Down
Loading