(pekko-grpc) branch main updated: fix: publish apiURL as scaladoc root (#891)

[fa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

pjfanning pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko-grpc.git


The following commit(s) were added to refs/heads/main by this push:
     new 32b42862 fix: publish apiURL as scaladoc root (#891)
32b42862 is described below

commit 32b428627b8884b1c7c6036591a1ae972619cf07
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Wed Sep 23 11:20:19 2026 +0100

    fix: publish apiURL as scaladoc root (#891)
    
    Motivation:
    The published apiURL pointed at the org/apache/pekko/grpc/index.html
    page rather than the scaladoc root. Downstream builds that use
    autoAPIMappings (e.g. pekko-projection) pass this to scaladoc as the
    external doc base, and scaladoc appends the fully-qualified class path,
    producing 404 links such as
    https://pekko.apache.org/api/pekko-grpc/2.0.0-M2/org/apache/pekko/grpc/org/apache/pekko/grpc/GrpcChannel.html
    
    Modification:
    Set apiURL to https://pekko.apache.org/api/pekko-grpc/<version>/ so
    that appending org/apache/pekko/grpc/<Class>.html resolves correctly.
    
    Result:
    Downstream scaladoc links to pekko-grpc classes resolve.
    
    Tests:
    - sbt runtime/makePom -> info.apiURL is https://pekko.apache.org/api/pekko-grpc/snapshot/
    - sbt scalafmtSbtCheck passes
    
    References:
    None - found via pekko-projection link-validator failure
    https://github.com/apache/pekko-projection/actions/runs/35568694883/job/106235549655
---
 project/Common.scala | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/project/Common.scala b/project/Common.scala
index b0529220..fde4621e 100644
--- a/project/Common.scala
+++ b/project/Common.scala
@@ -116,8 +116,7 @@ object Common extends AutoPlugin {
           "templates")
       }),
     Compile / doc / scalacOptions -= "-Xfatal-warnings",
-    apiURL := Some(
-      url(s"https://pekko.apache.org/api/pekko-grpc/${projectInfoVersion.value}/org/apache/pekko/grpc/index.html")),
+    apiURL := Some(url(s"https://pekko.apache.org/api/pekko-grpc/${projectInfoVersion.value}/")),
     (Test / testOptions) += Tests.Argument(TestFrameworks.ScalaTest, "-oDF"),
     crossScalaVersions := Seq(scala212, scala213, scala3),
     mimaReportSignatureProblems := true)


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org