(main) Fix and test Javadoc generation #708
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abelsromero
force-pushed
the
fix-and-test-java-docs
branch
2 times, most recently
from
cebe746 to
3391195
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce? (check at least one)
What is the goal of this pull request?
Ensure we don't find Javadoc issues right when are testing a release 🤦 To achieve it, we add a job to CI to run Javadoc generation and fail if something is wrong.
We DO accept warnings though, these are complaints about getter/setters and other that do not add value imho.
Are there any alternative ways to implement this?
We could enable Javadoc in the normal build, but that would slow the normal development and testing. I'd rather have it a separate CI job.
Are there any implications of this pull request? Anything a user must know?
Contributors would need to be aware that Javadocs are now a requirement, at least no errors.
Is it related to an existing issue?
Finally, please add a corresponding entry to CHANGELOG.adoc