Standardize java source headers #7205
Merged
Conversation
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
Update Checkstyle to validate all java source files have a standard header. Remove FixLiscenseHeaders.java unit test as it duplicates Checkstyle functionality. Standard header is block java comment, instead of dangling Javadoc comment. Create standard header template (HEADER_JAVA) in project root. Reference header template in build.gradle. Update CONTRIBUTING.md to exact text of header template.
Standardize License based off of HEADER_JAVA file. All headers are block Java comments.
Member
| Please don't remove the FixLicenseHeaders. |
Member
| Also please do not change the license start date, it should be 2016. |
Codecov Report
@@ Coverage Diff @@ ## 3.x #7205 +/- ## ============================================ - Coverage 99.54% 99.53% -0.01% - Complexity 6757 6758 +1 ============================================ Files 747 747 Lines 47387 47387 Branches 6384 6384 ============================================ - Hits 47170 47167 -3 - Misses 99 101 +2 - Partials 118 119 +1
Continue to review full report at Codecov.
|
Contributor Author
| Will fix. Do you have an issue with the header validation in Checkstyle being an error as I have it, or should I change it to a warning? I saw in comments on other commits that errors might not be welcome from Checkstyle. |
Contributor Author
| Also should all the Licenses have a 2016 date? I saw a handful of them that had different dates (i.e. 2017). |
Several files had 2017 dates for License. Checkstyle now specifically looks for 2016 date in License comments.
akarnokd approved these changes Mar 5, 2021
This was referenced Mar 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Convert License headers to block comments instead of dangling Javadoc comments. Use Checkstyle to validate Java source files have Licenses attached. Updated Checkstyle to most recent version. Updated Checkstyle configuration to remove mostly commented out code and update to correct DTD.
Removed unit test FixLicenseHeaders as the functionality is handled by the Checkstyle header validation.
One commit is Checkstyle and Gradle updates. Second commit is for all the Java source License updates.
Fixes #7204