Add checkstyle config #14
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
* Add Checkstyle config to make sure we are following the same style convention * Fix checkstyle issues in the current code base
haocheng
force-pushed
the
feat/add-checkstyle
branch
from
5b993e3 to
5622b28
Compare
haocheng
commented
Jul 3, 2023
Comment on lines
+43
to
+48
| - name: Upload checkstyle report | ||
| uses: actions/upload-artifact@v3 | ||
| if: success() || failure() | ||
| with: | ||
| name: checkstyle-report | ||
| path: build/checkstyle/*.html |
There was a problem hiding this comment.
I would like to display checkstyle report by using Push Checkstyle Report action but failed due to the Error: HttpError: Resource not accessible by integration issue...
haocheng
commented
Jul 3, 2023
| configProperties = ['checkstyleConfigDir': "$checkstyleConfigDir"] | ||
| ignoreFailures = true | ||
| reportsDir = project.file('build/checkstyle') | ||
| toolVersion = '9.3' |
There was a problem hiding this comment.
The latest version to support Java 8 is 9.x (10.x only supports Java 11)
haocheng
commented
Jul 4, 2023
| @@ -17,12 +17,14 @@ jobs: | |||
| java-version: ${{ matrix.java }} | |||
| architecture: x64 | |||
| - uses: actions/checkout@v3 | |||
|
|
|||
| with: | |||
| ref: ${{ github.event.pull_request.head.sha }} | |||
There was a problem hiding this comment.
Used ${{ github.event.pull_request.head.sha }} according to the suggestion on Push Checkstyle Report
haocheng
commented
Jul 4, 2023
| "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" | ||
| "https://checkstyle.org/dtds/configuration_1_3.dtd"> | ||
|
|
||
| <module name="Checker"> |
There was a problem hiding this comment.
I have copied this file from Armeria but removed checks related to Javadoc:
<module name="JavadocType">
<property name="scope" value="protected"/>
<property name="excludeScope" value="package"/>
</module>
<module name="JavadocMethod">
<property name="accessModifiers" value="protected, public"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowedAnnotations" value="Override, Test"/>
</module>
<module name="MissingJavadocMethod">
<property name="scope" value="protected"/>
</module>
<module name="MissingJavadocPackage"/>
<module name="MissingJavadocType"/>
<module name="JavadocParagraph"/>
<module name="JavadocTagContinuationIndentation"/>
kojilin
approved these changes
Jul 4, 2023
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.
Motivation:
Modifications:
pull_request_targetto workaround Github Action permission issueResult: