sbt packageDoc fails with error

[ksarath]

Hi,

Versions:
scala: 3.3.0
zio: 2.0.15
zio-config: 4.0.0-RC16
sbt: 1.9.2

I am getting he following error while generating Scala API documentation (sbt packageDoc)

[info] Main Scala API documentation to /Users/ksarath/projects/sample-project/target/scala-3.3.0/api...
[error] -- Error: yaml/shared/src/main/scala/zio/config/yaml/YamlConfigProvider.scala:16:0 
[error] undefined: new com.github.ghik.silencer.silent # -1: TermRef(TypeRef(TermRef(ThisType(TypeRef(NoPrefix,module class ghik)),object silencer),silent),<init>) at readTasty
[error] one error found
[error] (Compile / doc) DottyDoc Compilation Failed

[ksarath]

Here is sample code to reproduce the issue

import zio.ZIO
import zio.ZIOAppDefault
import zio.config.magnolia.deriveConfig
import zio.config.yaml.YamlConfigProvider

case class MyConfig(port: Int)

object Main extends ZIOAppDefault:

  def run = program

  val program: ZIO[Any, Throwable, Unit] =
    for
      _      <- ZIO.logInfo("Started submission service application")
      config <- YamlConfigProvider.fromYamlString("""port: 8080""").load(deriveConfig[MyConfig])
      _      <- ZIO.logInfo(s"config: $config")
    yield ()

[olliefreeman]

We had the same issue, this is because the Zio code is using com.github.ghik.silencer.silent which is not compatible (or needed) for Scala 3.

The workaround is to add the following to the sbt build settings for your project:

      Compile / packageDoc / publishArtifact := false,
      Compile / doc / sources := Seq.empty