Re: Problems with Javadoc for 2.39.0

[Yichi Zhang <zy...@google.com>]

There was no failure with the release script but seems the
:sdks:java:javadoc:aggregateJavadoc task was broken by
https://github.com/apache/beam/commit/e4d2050ccbaafb90428ab6c0cc494039f6282dae
.

Gradle command did not fail but the doc generation wasn't complete. I'll
try to fix that.


On Tue, May 31, 2022 at 9:27 AM Brian Hulette <bh...@google.com> wrote:

> > And here's the same page with the `current` slug in the path, which
> should redirect to 2.39.0:
>
> `current` doesn't redirect anymore, now it's a reference to the most
> recent release [1], so it's not surprising that both 2.39.0 and `current
> are failing in the same way.
>
> As for the issue - It looks like none of the top-level files were staged
> in beam-site for javadoc/2.39.0 [2]. Compare that to javadoc/2.38.0 [3]. @Yichi
> Zhang <zy...@google.com> did something go wrong here, or could it be a
> bug in the release script?
>
> [1] https://issues.apache.org/jira/browse/BEAM-12777
> [2] https://github.com/apache/beam-site/tree/release-docs/javadoc/2.39.0
> [3] https://github.com/apache/beam-site/tree/release-docs/javadoc/2.38.0
>
> On Mon, May 30, 2022 at 4:50 PM David Huntsperger <dh...@google.com>
> wrote:
>
>> Hey folks,
>>
>> It looks like there are a few issues with the latest Beam Javadoc. Here's
>> a page from 2.38.0:
>>
>>    -
>>    https://beam.apache.org/releases/javadoc/2.38.0/org/apache/beam/runners/dataflow/DataflowRunner.html
>>    - Loads correctly for me.
>>
>> Here's the same page for 2.39.0:
>>
>>    -
>>    https://beam.apache.org/releases/javadoc/2.39.0/org/apache/beam/runners/dataflow/DataflowRunner.html
>>    - Returns 404 for .css and .js files, for me.
>>
>> And here's the same page with the `current` slug in the path, which
>> should redirect to 2.39.0:
>>
>>    -
>>    https://beam.apache.org/releases/javadoc/current/org/apache/beam/runners/dataflow/DataflowRunner.html
>>    - Same as `2.39.0`: Returns 404 for .css and .js files, for me.
>>
>> I'm also seeing a number of URLs with the `current` slug where the entire
>> page is a 404, e.g.:
>>
>>    -
>>    https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/transforms/DoFn.html
>>
>> After the 2.38.0, we had some issues with deploying the Javadoc and the
>> redirect. Maybe the same thing? Python and Go seem fine, though I didn't do
>> a lot of testing.
>>
>> Thanks,
>>
>> David
>>
>

Re: Problems with Javadoc for 2.39.0

[Moritz Mack <mm...@talend.com>]

Hi Yichi,

Sorry for breaking that :/ I had a quick look and would suggest to only generate Javadocs for the latest Spark runner version. Please see here: https://github.com/apache/beam/pull/17793

The process of aggregating Javadocs is a bit sketchy in cases where source sets are shared. Particularly that’s the case for Spark and Flink runners.
Considering that everything is thrown into one bucket, we could easily end up with an inconsistent and misleading mix of Javadocs from multiple versions due to version specific overrides.

Unfortunately, I can’t tell what exactly triggered the issue. If disabling copying of shared base source altogether here, the warnings disappear but the task keeps failing.
https://github.com/apache/beam/blob/master/runners/spark/2/build.gradle#L26

I would suggest to also disable Javadocs for all versions of the Flink runner except the latest one to prevent any potential inconsistencies.

Best,
Moritz




On 01.06.22, 07:12, "Yichi Zhang" <zy...@google.com> wrote:

There was no failure with the release script but seems the :sdks:java:javadoc:aggregateJavadoc task was broken by https://github.com/apache/beam/commit/e4d2050ccbaafb90428ab6c0cc494039f6282dae.  Gradle command did not fail but the doc generation
ZjQcmQRYFpfptBannerStart
This Message Is From an External Sender
This message came from outside your organization.
Exercise caution when opening attachments or clicking any links.
ZjQcmQRYFpfptBannerEnd
There was no failure with the release script but seems the :sdks:java:javadoc:aggregateJavadoc task was broken by https://github.com/apache/beam/commit/e4d2050ccbaafb90428ab6c0cc494039f6282dae<https://urldefense.com/v3/__https:/github.com/apache/beam/commit/e4d2050ccbaafb90428ab6c0cc494039f6282dae__;!!CiXD_PY!VREMC-37FeXYq_Bgasv3mrIqqwMs8n4yFw4XO0HtmWodyKBGpvQkOzCkCU-TGZ73et5tsdoQPIM$>.

Gradle command did not fail but the doc generation wasn't complete. I'll try to fix that.


On Tue, May 31, 2022 at 9:27 AM Brian Hulette <bh...@google.com>> wrote:
> And here's the same page with the `current` slug in the path, which should redirect to 2.39.0:

`current` doesn't redirect anymore, now it's a reference to the most recent release [1], so it's not surprising that both 2.39.0 and `current are failing in the same way.

As for the issue - It looks like none of the top-level files were staged in beam-site for javadoc/2.39.0 [2]. Compare that to javadoc/2.38.0 [3]. @Yichi Zhang<ma...@google.com> did something go wrong here, or could it be a bug in the release script?

[1] https://issues.apache.org/jira/browse/BEAM-12777<https://urldefense.com/v3/__https:/issues.apache.org/jira/browse/BEAM-12777__;!!CiXD_PY!VREMC-37FeXYq_Bgasv3mrIqqwMs8n4yFw4XO0HtmWodyKBGpvQkOzCkCU-TGZ73et5tTgNbEWQ$>
[2] https://github.com/apache/beam-site/tree/release-docs/javadoc/2.39.0<https://urldefense.com/v3/__https:/github.com/apache/beam-site/tree/release-docs/javadoc/2.39.0__;!!CiXD_PY!VREMC-37FeXYq_Bgasv3mrIqqwMs8n4yFw4XO0HtmWodyKBGpvQkOzCkCU-TGZ73et5t45OVF8c$>
[3] https://github.com/apache/beam-site/tree/release-docs/javadoc/2.38.0<https://urldefense.com/v3/__https:/github.com/apache/beam-site/tree/release-docs/javadoc/2.38.0__;!!CiXD_PY!VREMC-37FeXYq_Bgasv3mrIqqwMs8n4yFw4XO0HtmWodyKBGpvQkOzCkCU-TGZ73et5tDp0xC5M$>

On Mon, May 30, 2022 at 4:50 PM David Huntsperger <dh...@google.com>> wrote:
Hey folks,

It looks like there are a few issues with the latest Beam Javadoc. Here's a page from 2.38.0:
·         https://beam.apache.org/releases/javadoc/2.38.0/org/apache/beam/runners/dataflow/DataflowRunner.html<https://urldefense.com/v3/__https:/beam.apache.org/releases/javadoc/2.38.0/org/apache/beam/runners/dataflow/DataflowRunner.html__;!!CiXD_PY!VREMC-37FeXYq_Bgasv3mrIqqwMs8n4yFw4XO0HtmWodyKBGpvQkOzCkCU-TGZ73et5tugMcO8w$> - Loads correctly for me.
Here's the same page for 2.39.0:
·         https://beam.apache.org/releases/javadoc/2.39.0/org/apache/beam/runners/dataflow/DataflowRunner.html<https://urldefense.com/v3/__https:/beam.apache.org/releases/javadoc/2.39.0/org/apache/beam/runners/dataflow/DataflowRunner.html__;!!CiXD_PY!VREMC-37FeXYq_Bgasv3mrIqqwMs8n4yFw4XO0HtmWodyKBGpvQkOzCkCU-TGZ73et5tFLBU-yU$> - Returns 404 for .css and .js files, for me.
And here's the same page with the `current` slug in the path, which should redirect to 2.39.0:
·         https://beam.apache.org/releases/javadoc/current/org/apache/beam/runners/dataflow/DataflowRunner.html<https://urldefense.com/v3/__https:/beam.apache.org/releases/javadoc/current/org/apache/beam/runners/dataflow/DataflowRunner.html__;!!CiXD_PY!VREMC-37FeXYq_Bgasv3mrIqqwMs8n4yFw4XO0HtmWodyKBGpvQkOzCkCU-TGZ73et5tpOABuMw$> - Same as `2.39.0`: Returns 404 for .css and .js files, for me.
I'm also seeing a number of URLs with the `current` slug where the entire page is a 404, e.g.:
·         https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/transforms/DoFn.html<https://urldefense.com/v3/__https:/beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/transforms/DoFn.html__;!!CiXD_PY!VREMC-37FeXYq_Bgasv3mrIqqwMs8n4yFw4XO0HtmWodyKBGpvQkOzCkCU-TGZ73et5tOtskHsQ$>
After the 2.38.0, we had some issues with deploying the Javadoc and the redirect. Maybe the same thing? Python and Go seem fine, though I didn't do a lot of testing.

Thanks,

David

As a recipient of an email from Talend, your contact personal data will be on our systems. Please see our privacy notice. <https://www.talend.com/privacy/>