-
-
Notifications
You must be signed in to change notification settings - Fork 543
Add JDoc checks to PR pipeline #1357
Copy link
Copy link
Open
Labels
enhancementNew feature or requestNew feature or requestgood first issueEasy/simple issues perfect for newcomers to get involved in the projectEasy/simple issues perfect for newcomers to get involved in the projectmetaRelated to the project but not strictly to codeRelated to the project but not strictly to code
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestgood first issueEasy/simple issues perfect for newcomers to get involved in the projectEasy/simple issues perfect for newcomers to get involved in the projectmetaRelated to the project but not strictly to codeRelated to the project but not strictly to code
Checklist
Feature description
Check javadoc as part of the CI / PR pipeline to detect faulty docs before adding them to the dev branch.
Why do you want this feature?
Sometimes wrong JDoc is introduced in PRs. Format that is not accepted by the
aggregatedJavadocstask lets the automated publishing of the docs fail which has been repeatedly happened after publishing a new version.Additional information
An example PR fixing JDoc issues is #1356