pjfanning opened a new pull request, #891:
URL: https://github.com/apache/pekko-grpc/pull/891

   ### Motivation
   The published `info.apiURL` in our POMs points at 
`.../org/apache/pekko/grpc/index.html` 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 with a duplicated package path such as:
   
   
`https://pekko.apache.org/api/pekko-grpc/2.0.0-M2/org/apache/pekko/grpc/org/apache/pekko/grpc/GrpcChannel.html`
   
   The same bug is present in the 1.1.1 and 1.2.0 POMs.
   
   ### Modification
   Set `apiURL` to `https://pekko.apache.org/api/pekko-grpc/<version>/` so that 
appending `org/apache/pekko/grpc/<Class>.html` resolves correctly. This matches 
what pekko-projection already does for its own `apiURL`.
   
   ### Result
   Downstream scaladoc links to pekko-grpc classes resolve once a release with 
this change is published.
   
   ### Tests
   - `sbt runtime/makePom` -> generated POM has 
`<info.apiURL>https://pekko.apache.org/api/pekko-grpc/snapshot/</info.apiURL>`
   - `sbt scalafmtSbtCheck` passes
   
   ### References
   None - found via pekko-projection link-validator failure: 
https://github.com/apache/pekko-projection/actions/runs/35568694883/job/106235549655
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to