Skip to content

Commit

Permalink
Update build to publish ScalaDoc with links
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeff May committed Sep 30, 2022
1 parent 05d5c99 commit 278d348
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
7 changes: 3 additions & 4 deletions build.sbt
Expand Up @@ -28,10 +28,6 @@ ThisBuild / developers := List(
Developer(id = "jeffmay", name = "Jeff May", email = "jeff.n.may@gmail.com", url = url("https://github.com/jeffmay")),
)

// ScalaDoc generation is generally broken. It's really mostly useful from within the IDE anyway
// so just disable generation to allow publishing without ScalaDoc errors.
ThisBuild / packageDoc / publishArtifact := false

// Disable publishing of the root project
publish / skip := true

Expand All @@ -49,13 +45,16 @@ def commonProject(
.settings(
name := s"vapors-$dir",
idePackagePrefix.withRank(KeyRanks.Invisible) := Some(packagePrefix),
Compile / doc / scalacOptions += "--no-link-warnings",
Test / doc / scalacOptions += "--no-link-warnings",
addCompilerPlugin(("org.typelevel" % "kind-projector" % "0.13.2").cross(CrossVersion.full)),
)
}

lazy val bench = commonProject("bench", "vapors")
.dependsOn(`core-v1` % "test->test") // TODO: Include other projects for comparison
.settings(
publish / skip := true,
libraryDependencies ++= BenchProject.all,
Test / parallelExecution := false,
)
Expand Down
1 change: 1 addition & 0 deletions project/plugins.sbt
@@ -1,5 +1,6 @@
addSbtPlugin("com.codecommit" % "sbt-github-actions" % "0.14.2")
addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.10")
addSbtPlugin("com.thoughtworks.sbt-api-mappings" % "sbt-api-mappings" % "3.0.2")
addSbtPlugin("org.jetbrains.scala" % "sbt-ide-settings" % "1.1.1")
addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.6")
addSbtPlugin("org.scoverage" % "sbt-scoverage" % "2.0.3")

0 comments on commit 278d348

Please sign in to comment.