apache / pekko-http

The Streaming-first HTTP server/module of Apache Pekko
https://pekko.apache.org/
Apache License 2.0
152 stars 36 forks source link

scaladoc links to java runtime classes are broken #216

Closed pjfanning closed 1 year ago

pjfanning commented 1 year ago

see https://github.com/apache/incubator-pekko-http/actions/runs/5427033437/jobs/9878610786

has issues like:

`[https://docs.oracle.com/en/java/javase/11/docs/api/java/util/Map.html`](https://docs.oracle.com/en/java/javase/11/docs/api/java/util/Map.html) status 404 Not Found
 - ../../../../../target/scala-2.13/unidoc/org/apache/pekko/http/javadsl/model/headers/HttpCredentials.html
 - ../../../../../target/scala-2.13/unidoc/org/apache/pekko/http/javadsl/server/AllDirectives.html
 - ... 3 more

should be https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html

The sbt settings closely match those in incubator-pekko but the scaladoc is generating ok in incubator-pekko

mdedetrich commented 1 year ago

Ill look into this

mdedetrich commented 1 year ago

@pjfanning So I think the core issue is this https://github.com/ThoughtWorksInc/sbt-api-mappings/blob/5b1e4f11647421d287d3a26ed7fb077474ea7a3e/src/main/scala/com/thoughtworks/sbtApiMappings/BootstrapApiMappings.scala#L37-L43 although I am still getting the issue when running with JDK 11, investigating further

mdedetrich commented 1 year ago

Re-opening since its still broken

pjfanning commented 1 year ago

@mdedetrich is this safe to close? - we have the link-validator job running in CI

mdedetrich commented 1 year ago

Yes

jrudolph commented 1 year ago

No, the link validator is still broken.

mdedetrich commented 1 year ago

@jrudolph Huh? https://github.com/apache/incubator-pekko-http/actions/runs/5643524801

jrudolph commented 1 year ago

Last time it ran, it failed, and then removed its settings accidentally...

https://github.com/apache/incubator-pekko-http/actions/runs/5643524801/job/15285543470#step:8:9

can't read [scripts/link-validator.conf]

It seems to fail silently.

mdedetrich commented 1 year ago

Oh I see, let me rename issue so it's clearer then

jrudolph commented 1 year ago

This issue is probably still existing, and the other is another issue which masks this.

mdedetrich commented 1 year ago

This issue is probably still existing, and the other is another issue which masks this.

I remember fixing/verifying the broken links, so unless some change was introduced which broke the links it should be fine.

jrudolph commented 1 year ago

:+1: