You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "Parkerhiphop (via GitHub)" <gi...@apache.org> on 2025/02/11 16:09:46 UTC
[PR] MINOR: add javadoc to build phase [kafka]
Parkerhiphop opened a new pull request, #18863:
URL: https://github.com/apache/kafka/pull/18863
Add javadoc check to build phase to catch documentation errors early, similar to #18183.
This was motivated by a [comment](https://github.com/apache/kafka/pull/18760#issuecomment-2648206457) in #18760 to reduce the burden on reviewers for javadoc validation.
While #18838 fixed the immediate doc issue, this change helps prevent similar problems proactively.
### Committer Checklist (excluded from commit message)
- [ ] Verify design and implementation
- [ ] Verify test coverage and CI build status
- [ ] Verify documentation (including upgrade notes)
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: check javadoc while build phase [kafka]
Posted by "mumrah (via GitHub)" <gi...@apache.org>.
mumrah commented on code in PR #18863:
URL: https://github.com/apache/kafka/pull/18863#discussion_r1953424717
##########
streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java:
##########
@@ -540,7 +540,7 @@ <VOut> KStream<K, VOut> flatMapValues(final ValueMapperWithKey<? super K, ? supe
void to(final String topic);
/**
- * See {@link #to(String)}.
+ * See {@link #to(String).}
Review Comment:
@Parkerhiphop can you revert this temporary change?
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add javadoc to build phase [kafka]
Posted by "gharris1727 (via GitHub)" <gi...@apache.org>.
gharris1727 commented on PR #18863:
URL: https://github.com/apache/kafka/pull/18863#issuecomment-2652267155
I tried to fix this before in #16025
Maybe it could also be fixed by changing `test.dependsOn('javadoc')` to `check.dependsOn('javadoc')`?
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add javadoc to build phase [kafka]
Posted by "Parkerhiphop (via GitHub)" <gi...@apache.org>.
Parkerhiphop commented on code in PR #18863:
URL: https://github.com/apache/kafka/pull/18863#discussion_r1951218443
##########
.github/workflows/build.yml:
##########
@@ -113,7 +114,7 @@ jobs:
# --scan: Publish the build scan. This will only work on PRs from apache/kafka and trunk
# --no-scan: For public fork PRs, we won't attempt to publish the scan
run: |
- ./gradlew --build-cache --info $SCAN_ARG check siteDocTar -x test
+ ./gradlew --build-cache --info $SCAN_ARG check siteDocTar javadoc -x test |& tee gradle-output.log
Review Comment:
@chia7712 Yes. Thanks for correcting!
I intended to log the specific file and line number.
Is it ok if the build process just fails?
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add javadoc to build phase [kafka]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 commented on code in PR #18863:
URL: https://github.com/apache/kafka/pull/18863#discussion_r1951178305
##########
.github/workflows/build.yml:
##########
@@ -113,7 +114,7 @@ jobs:
# --scan: Publish the build scan. This will only work on PRs from apache/kafka and trunk
# --no-scan: For public fork PRs, we won't attempt to publish the scan
run: |
- ./gradlew --build-cache --info $SCAN_ARG check siteDocTar -x test
+ ./gradlew --build-cache --info $SCAN_ARG check siteDocTar javadoc -x test |& tee gradle-output.log
Review Comment:
IIRC, the exit code returned by `javadoc` can stop the build, right? If so, it seems we don't need to parse the output?
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: check javadoc while build phase [kafka]
Posted by "Parkerhiphop (via GitHub)" <gi...@apache.org>.
Parkerhiphop commented on code in PR #18863:
URL: https://github.com/apache/kafka/pull/18863#discussion_r1953745323
##########
streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java:
##########
@@ -540,7 +540,7 @@ <VOut> KStream<K, VOut> flatMapValues(final ValueMapperWithKey<? super K, ? supe
void to(final String topic);
/**
- * See {@link #to(String)}.
+ * See {@link #to(String).}
Review Comment:
@mumrah Yes, I revert this temporary change.
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add javadoc to build phase [kafka]
Posted by "Parkerhiphop (via GitHub)" <gi...@apache.org>.
Parkerhiphop commented on code in PR #18863:
URL: https://github.com/apache/kafka/pull/18863#discussion_r1951218443
##########
.github/workflows/build.yml:
##########
@@ -113,7 +114,7 @@ jobs:
# --scan: Publish the build scan. This will only work on PRs from apache/kafka and trunk
# --no-scan: For public fork PRs, we won't attempt to publish the scan
run: |
- ./gradlew --build-cache --info $SCAN_ARG check siteDocTar -x test
+ ./gradlew --build-cache --info $SCAN_ARG check siteDocTar javadoc -x test |& tee gradle-output.log
Review Comment:
@chia7712 Yes. Thanks for correcting!
I intended to log the specific file and line number.
Is it acceptable if the build process just fails?
And I use the same error from #18838 to test.
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add javadoc to build phase [kafka]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 commented on PR #18863:
URL: https://github.com/apache/kafka/pull/18863#issuecomment-2652271553
> Maybe it could also be fixed by changing test.dependsOn('javadoc') to check.dependsOn('javadoc')?
Yes, that's a simpler approach.
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: check javadoc while build phase [kafka]
Posted by "mumrah (via GitHub)" <gi...@apache.org>.
mumrah merged PR #18863:
URL: https://github.com/apache/kafka/pull/18863
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: check javadoc while build phase [kafka]
Posted by "Parkerhiphop (via GitHub)" <gi...@apache.org>.
Parkerhiphop commented on PR #18863:
URL: https://github.com/apache/kafka/pull/18863#issuecomment-2652606197
> I tried to fix this before in #16025
>
> Maybe it could also be fixed by changing `test.dependsOn('javadoc')` to `check.dependsOn('javadoc')`?
@gharris1727 Thanks for pointing out a better solution!
Changing `test.dependsOn('javadoc')` to `check.dependsOn('javadoc')` makes more sense.
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add javadoc to build phase [kafka]
Posted by "Parkerhiphop (via GitHub)" <gi...@apache.org>.
Parkerhiphop commented on code in PR #18863:
URL: https://github.com/apache/kafka/pull/18863#discussion_r1951218443
##########
.github/workflows/build.yml:
##########
@@ -113,7 +114,7 @@ jobs:
# --scan: Publish the build scan. This will only work on PRs from apache/kafka and trunk
# --no-scan: For public fork PRs, we won't attempt to publish the scan
run: |
- ./gradlew --build-cache --info $SCAN_ARG check siteDocTar -x test
+ ./gradlew --build-cache --info $SCAN_ARG check siteDocTar javadoc -x test |& tee gradle-output.log
Review Comment:
@chia7712 Yes. Thanks for correcting!
I intended to log the specific file and line number.
Is it ok if the build process just fails?
And I use the same error from #18838 to test.
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: check javadoc while build phase [kafka]
Posted by "Parkerhiphop (via GitHub)" <gi...@apache.org>.
Parkerhiphop commented on code in PR #18863:
URL: https://github.com/apache/kafka/pull/18863#discussion_r1953745323
##########
streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java:
##########
@@ -540,7 +540,7 @@ <VOut> KStream<K, VOut> flatMapValues(final ValueMapperWithKey<? super K, ? supe
void to(final String topic);
/**
- * See {@link #to(String)}.
+ * See {@link #to(String).}
Review Comment:
@mumrah Yes, I revert this temporary change.
Thanks for reviewing!
--
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: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org