fixing javadocs #3536
fixing javadocs #3536
Conversation
| */ | ||
|
|
||
|
|
||
| package org.apache.heron.examples.streamlet; |
There was a problem hiding this comment.
This file caused a break in the build as the pulsar library wasn't included in the project anymore. We can add it back at a later time when/if we add a packaged pulsar spout to the contrib code base
There was a problem hiding this comment.
Want me to take a look at fixing this before the merge?
There was a problem hiding this comment.
yeah that'd be great. It's probably better than just throwing it away.
There was a problem hiding this comment.
Hey @nicknezis I'm still getting those errors while generating javadocs when building locally after your push
/Users/joshfischer/Source/apache/incubator-heron/examples/src/java/org/apache/heron/examples/streamlet/SimplePulsarSourceTopology.java:34: error: package org.apache.pulsar.client.api does not exist
import org.apache.pulsar.client.api.Consumer;
^
/Users/joshfischer/Source/apache/incubator-heron/examples/src/java/org/apache/heron/examples/streamlet/SimplePulsarSourceTopology.java:35: error: package org.apache.pulsar.client.api does not exist
import org.apache.pulsar.client.api.PulsarClient;
^
/Users/joshfischer/Source/apache/incubator-heron/examples/src/java/org/apache/heron/examples/streamlet/SimplePulsarSourceTopology.java:36: error: package org.apache.pulsar.client.api does not exist
import org.apache.pulsar.client.api.PulsarClientException;
^
/Users/joshfischer/Source/apache/incubator-heron/examples/src/java/org/apache/heron/examples/streamlet/SimplePulsarSourceTopology.java:52: error: cannot find symbol
private PulsarClient client;
^
symbol: class PulsarClient
location: class PulsarSource
/Users/joshfischer/Source/apache/incubator-heron/examples/src/java/org/apache/heron/examples/streamlet/SimplePulsarSourceTopology.java:53: error: cannot find symbol
private Consumer consumer;
^
symbol: class Consumer
location: class PulsarSource
5 errors
There was a problem hiding this comment.
To reproduce execute the below from the root directory of the project:
$ cd website2/website && make javadocs
There was a problem hiding this comment.
Weird, I originally got the error, but then after the edit it went away. I do get a long list of warnings about invalid use of tags. I'll try a fresh git clone and see if it fails again.
There was a problem hiding this comment.
Interesting. I was able to recreate the issue. Apparently at some point I had run bazel build --config=darwin examples/src/java/... and that made the problem go away. After running bazel clean --expunge, the issue came back. I'll keep looking into it.
| "__AUTOGENERATED_FILE_DO_NOT_MODIFY_THIS_FILE_MANUALLY": 607867898, | ||
| "__AUTOGENERATED_FILE_DO_NOT_MODIFY_THIS_FILE_MANUALLY": -512671146, | ||
| "conflict_resolution": {}, |
There was a problem hiding this comment.
I have a question outside the scope of this PR. It looks like this file is auto generated from the maven rule. Should this be checked into SCM?
There was a problem hiding this comment.
I think so. So you can use the external_jvm_rules feature without this file, but anytime someone builds it will resolve the transitive dependencies and can lead to issues. Also performance and ability to do offline builds are impacted. Some good info on the feature here: https://github.com/bazelbuild/rules_jvm_external#pinning-artifacts-and-integration-with-bazels-downloader
One way to think of it is this. Before the WORKSPACE file had a longer list of Jar artifacts with SHA256, the tool now produces this file with the various files.
One key thing that I worry might trip someone up is that changes to the list of Maven dependencies in the WORKSPACE file aren't automatically honored. You have to first run bazel run @unpinned_maven//:pin to update the file. I put a comment in the WORKSPACE file as a reminder in case anyone tried to update versions of dependencies.
There was a problem hiding this comment.
Ok. Thanks for the info. I'll make sure to read up on this.
|
Interesting. Thanks for looking!
…On Sat, Jun 6, 2020 at 12:19 PM Nicholas Nezis ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In
examples/src/java/org/apache/heron/examples/streamlet/SimplePulsarSourceTopology.java
<#3536 (comment)>
:
> - * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-
-package org.apache.heron.examples.streamlet;
Interesting. I was able to recreate the issue. Apparently at some point I
had run bazel build --config=darwin examples/src/java/... and that made
the problem go away. After running bazel clean --expunge, the issue came
back. I'll keep looking into it.
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub
<#3536 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABQPBH54OOQTGP7M2ORQCTTRVKJEJANCNFSM4NVGCYKQ>
.
|
|
Cool. Let me try to build again!
…On Sun, Jun 7, 2020 at 5:56 AM Josh Fischer ***@***.***> wrote:
Merged #3536 <#3536> into
master.
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub
<#3536 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABQPBHYNI5BOUUUQLB4VG6TRVOFBDANCNFSM4NVGCYKQ>
.
|
* fixing javadocs * Adding back Pulsar Streamlet example * Excluding examples folder from javadocs * clean up Co-authored-by: Nicholas Nezis <nicholas.nezis@gmail.com>
This PR fixes the Java doc build for the website.