dberna2/Checkstyle for Java
Run Checkstyle analysis on Java code and report the results directly to the pull request using ReviewDog.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | This is the GitHub personal access token used for authentication. It's required by ReviewDog to report the results of the Checkstyle analysis in the pull request | — | ${{ github.token }} |
| workdir | This is the current working directory. By default, it's the root directory of the repository. | — | . |
| excluded_paths | Directory/file pattern to exclude from CheckStyle. Multiple excludes are allowed | — | "" |
| level | This is the severity level that ReviewDog uses when reporting issues found. Levels can be info, warning, or error. | — | info |
| reporter | This setting defines how issues found are reported. Possible values are github-check (will create a check review that appears in the PR's Checks tab), github-pr-check (comments will be attached to the PR's code line), and github-pr-review (will create a review on the PR). | — | github-pr-check |
| filter_mode | This setting determines how ReviewDog filters results to report. Possible values are added (will report only on lines added in the PR), diff_context (will report only on changes in the diff context), file (will report on all changes in modified files), nofilter (all occurrences will be reported). | — | added |
| fail_on_error | his option allows the action's workflow to fail if ReviewDog finds any error. Possible values are true and false. | — | false |
| checkstyle_config | This is the path to the Checkstyle configuration file that defines the set of code style rules to use during the analysis. | — | ./google_checks.xml |
| use_custom_validations | This is a flag to enable the use of custom validations. By default, it's disabled. | — | false |
| custom_validations | This is the path to the custom validations file that defines the set of custom validations to use during the analysis. | — | . |
| checkstyle_version | This is the Checkstyle version to be used during the analysis. By default, the latest version is used. | — | 10.18.2 |
Outputs
no outputs