[RelEng] Add JavaDoc-Basher Pull-Request check#3115
Merged
Conversation
HannesWell
force-pushed
the
add-javadoc-check
branch
2 times, most recently
from
18ca2fc to
fa12f12
Compare
Member
Author
|
In case of inconsistencies the check fails Clicking on the details of the failed check shows the diff and an expressive message: |
The added check runs the javadoc-basher on each PR and ensures the JavaDoc of all public API elements is synchronized for all platforms. In case that run leads to changes in the git worktree, the check fails.
HannesWell
force-pushed
the
add-javadoc-check
branch
from
fa12f12 to
c612857
Compare
Contributor
Test Results 176 files 176 suites 28m 34s ⏱️ Results for commit c612857. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The added check runs the javadoc-basher on each PR and ensures the JavaDoc of all public API elements is synchronized for all platforms. In case that run leads to changes in the git worktree, the check fails.
This ensures the JavaDoc is always properly in sync und thus avoids the need to verify JavaDoc consistency before the release as separate RelEng task, like it was done for example in