Automatically set tlSiteApiModule from unidoc plugin

typelevel · Mar 1, 2022 · 0e013b4 · 0e013b4
1 parent 46bf8ef
commit 0e013b4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/build.sbt b/build.sbt
@@ -162,7 +162,6 @@ lazy val docs = project
   .enablePlugins(TypelevelSitePlugin)
   .settings(
     laikaConfig ~= { _.withRawContent },
-    tlSiteApiModule := Some((unidoc / projectID).value),
     tlSiteApiPackage := Some("org.typelevel.sbt"),
     tlSiteRelatedProjects := Seq(
       "sbt" -> url("https://www.scala-sbt.org/"),

diff --git a/site/src/main/scala/org/typelevel/sbt/TypelevelSitePlugin.scala b/site/src/main/scala/org/typelevel/sbt/TypelevelSitePlugin.scala
@@ -46,7 +46,7 @@ object TypelevelSitePlugin extends AutoPlugin {
       settingKey[ThemeProvider]("The Typelevel Helium extensions")
     lazy val tlSiteApiUrl = settingKey[Option[URL]]("URL to the API docs")
     lazy val tlSiteApiModule =
-      settingKey[Option[ModuleID]]("The project that publishes API docs")
+      settingKey[Option[ModuleID]]("The module that publishes API docs")
     lazy val tlSiteApiPackage = settingKey[Option[String]](
       "The top-level package for your API docs (e.g. org.typlevel.sbt)")
     lazy val tlSiteRelatedProjects =
@@ -75,10 +75,13 @@ object TypelevelSitePlugin extends AutoPlugin {
   override def requires =
     MdocPlugin && LaikaPlugin && TypelevelGitHubPlugin && GenerativePlugin && NoPublishPlugin
 
+  override def globalSettings = Seq(
+    tlSiteApiModule := None
+  )
+
   override def buildSettings = Seq(
     tlSitePublishBranch := Some("main"),
     tlSiteApiUrl := None,
-    tlSiteApiModule := None,
     tlSiteApiPackage := None,
     tlSiteRelatedProjects := Seq(TypelevelProject.Cats),
     tlSiteKeepFiles := true,

diff --git a/sonatype/src/main/scala/org/typelevel/sbt/TypelevelUnidocPlugin.scala b/sonatype/src/main/scala/org/typelevel/sbt/TypelevelUnidocPlugin.scala
@@ -32,7 +32,9 @@ object TypelevelUnidocPlugin extends AutoPlugin {
   override def projectSettings = Seq(
     Compile / packageDoc / mappings := (ScalaUnidoc / packageDoc / mappings).value,
     ThisBuild / apiURL := javadocioUrl.value,
-    mimaPreviousArtifacts := Set.empty
+    mimaPreviousArtifacts := Set.empty,
+    // tell the site plugin about us, without forcing the dependency!
+    ThisBuild / SettingKey[Option[ModuleID]]("tlSiteApiModule") := Some(projectID.value)
   )
 
 }