Fix apiURL for autoAPIMappings

apache · Sep 20, 2023 · 529ed8d · 529ed8d
1 parent 288c515
commit 529ed8d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/docs/src/main/paradox/release-notes/index.md b/docs/src/main/paradox/release-notes/index.md
@@ -2,6 +2,13 @@
 
 To understand the forces on version numbers, read about @ref:[Apache Pekko Connectors' versioning scheme](../other-docs/versioning.md).
 
+## 1.0.1
+
+### Bug Fixes
+
+* Fix `apiURL` so that projects depending on pekko-connectors have the correct
+url in their scaladocs via sbt's [autoAPIMappings](https://www.scala-sbt.org/1.x/docs/Howto-Scaladoc.html#Define+the+location+of+API+documentation+for+a+library) feature ([PR252](https://github.com/apache/incubator-pekko-connectors/pull/252))
+
 ## 1.0.0
 
 Apache Pekko Connectors 1.0.0 is based on Alpakka 4.0.0. Pekko came about as a result of Lightbend's decision to make future

diff --git a/project/Common.scala b/project/Common.scala
@@ -111,8 +111,10 @@ object Common extends AutoPlugin {
       case _ => Seq.empty[String]
     }),
     autoAPIMappings := true,
-    apiURL := Some(url(
-      s"https://pekko.apache.org/api/pekko-connectors/${version.value}/org/apache/pekko/stream/connectors/index.html")),
+    apiURL := {
+      val apiVersion = if (isSnapshot.value) "current" else version.value
+      Some(url(s"https://pekko.apache.org/api/pekko-connectors/$apiVersion/"))
+    },
     // show full stack traces and test case durations
     Test / testOptions += Tests.Argument("-oDF"),
     // -a Show stack traces and exception class name for AssertionErrors.