You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "Abacn (via GitHub)" <gi...@apache.org> on 2025/07/09 21:23:04 UTC
[PR] Fix javadoc workflow [beam]
Abacn opened a new pull request, #35551:
URL: https://github.com/apache/beam/pull/35551
**Please** add a meaningful description for your change here
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix javadoc workflow [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on code in PR #35551:
URL: https://github.com/apache/beam/pull/35551#discussion_r2197895116
##########
sdks/java/javadoc/build.gradle:
##########
@@ -83,4 +81,22 @@ task aggregateJavadoc(type: Javadoc) {
links createJavadocIOUrlForDependency(dep)
}
}
+
+ // certain projects need generated sources for javadoc generation
+ // Part of flink sources came from custom copySourceOverrides target
+ dependsOn ":runners:flink:${flink_versions.split(",").first()}:copySourceOverrides"
+ // Auto value class appeared in class annotation (jackson)
+ dependsOn ':sdks:java:io:solace:compileJava'
+ source project(':sdks:java:io:solace').layout.buildDirectory.dir('generated/sources/annotationProcessor/java/main')
+ dependsOn ':sdks:java:io:amazon-web-services2:compileJava'
+ source project(':sdks:java:io:amazon-web-services2').layout.buildDirectory.dir('generated/sources/annotationProcessor/java/main')
+
+ doLast {
+ File myFile = new File(layout.buildDirectory.dir("docs/javadoc/index.html").get().toString())
Review Comment:
I observe that when `aggregateJavadoc` executed (not "from cache"), the javadoc/ dir first get cleaned up, with all previous files deleted. The directory remains empty until the target nearly ends (all files propagated within 1 second). This explains if javadoc failed early no file gets written at all.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix javadoc workflow [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on code in PR #35551:
URL: https://github.com/apache/beam/pull/35551#discussion_r2196033596
##########
.github/workflows/beam_PostCommit_Javadoc.yml:
##########
@@ -74,6 +74,8 @@ jobs:
github_job: ${{ matrix.job_name }} (${{ matrix.job_phrase }})
- name: Setup environment
uses: ./.github/actions/setup-environment-action
+ with:
+ java-version: 21
Review Comment:
Due to some Beam module requires higher java version, run `./gradlew :sdks:java:javadoc:aggregateJavadoc` with Java11 fails with
```
bad class file: /Users/yathu/.gradle/caches/modules-2/files-2.1/io.debezium/debezium-core/3.1.1.Final/44cc4060846bce89761529b040accf2625e3dc0e/debezium-core-3.1.1.Final.jar(/io/debezium/relational/history/AbstractSchemaHistory.class)
class file has wrong version 61.0, should be 55.0
```
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix javadoc workflow [beam]
Posted by "damccorm (via GitHub)" <gi...@apache.org>.
damccorm commented on code in PR #35551:
URL: https://github.com/apache/beam/pull/35551#discussion_r2197739703
##########
sdks/java/javadoc/build.gradle:
##########
@@ -83,4 +81,22 @@ task aggregateJavadoc(type: Javadoc) {
links createJavadocIOUrlForDependency(dep)
}
}
+
+ // certain projects need generated sources for javadoc generation
+ // Part of flink sources came from custom copySourceOverrides target
+ dependsOn ":runners:flink:${flink_versions.split(",").first()}:copySourceOverrides"
+ // Auto value class appeared in class annotation (jackson)
+ dependsOn ':sdks:java:io:solace:compileJava'
+ source project(':sdks:java:io:solace').layout.buildDirectory.dir('generated/sources/annotationProcessor/java/main')
+ dependsOn ':sdks:java:io:amazon-web-services2:compileJava'
+ source project(':sdks:java:io:amazon-web-services2').layout.buildDirectory.dir('generated/sources/annotationProcessor/java/main')
+
+ doLast {
+ File myFile = new File(layout.buildDirectory.dir("docs/javadoc/index.html").get().toString())
Review Comment:
Is it possible for this to get generated while still having other important parts of the javadoc fail to get generated?
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix javadoc workflow [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn merged PR #35551:
URL: https://github.com/apache/beam/pull/35551
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix javadoc workflow [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #35551:
URL: https://github.com/apache/beam/pull/35551#issuecomment-3055328866
Assigning reviewers:
R: @ahmedabu98 for label java.
R: @damccorm for label build.
Note: If you would like to opt out of this review, comment `assign to next reviewer`.
Available commands:
- `stop reviewer notifications` - opt out of the automated review tooling
- `remind me after tests pass` - tag the comment author after tests pass
- `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
The PR bot will only process comments in the main thread (not review comments).
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix javadoc workflow [beam]
Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on PR #35551:
URL: https://github.com/apache/beam/pull/35551#issuecomment-3055210730
test passed: https://github.com/apache/beam/actions/runs/16185112241/job/45689130867
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org