dbelyaev/Java Checkstyle Reviewer
Enforce Java code standards in PRs with inline feedback. Powered by Checkstyle + reviewdog for GitHub integration.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | GitHub token for API authentication. Use secrets.GITHUB_TOKEN for automatic authentication. | — | ${{ github.token }} |
| workdir | Working directory for Checkstyle analysis, relative to the repository root. | — | . |
| level | Severity level for reported violations [info, warning, error]. Affects GitHub status check results. | — | info |
| reporter | How reviewdog reports violations [github-pr-check, github-check, github-pr-review]. See reviewdog documentation for details. | — | github-pr-check |
| filter_mode | Filtering mode for reviewdog [added, diff_context, file, nofilter]. Controls which files/lines are analyzed. See reviewdog documentation for details. | — | added |
| fail_level | When to fail the workflow [none, any, info, warning, error]. Set to fail when violations at or above the specified severity are found. Default 'none' never fails. | — | none |
| reviewdog_flags | Additional flags to pass to the reviewdog command. | — | "" |
| checkstyle_config | Checkstyle ruleset to apply during analysis. Built-in: google_checks.xml (Google Java Style), sun_checks.xml (Sun Code Conventions). Or provide path to custom config file relative to repository root. | — | google_checks.xml |
| checkstyle_version | Checkstyle version to use for analysis. See https://github.com/checkstyle/checkstyle/releases/ Default: latest version (automatically updated). RECOMMENDED: Pin to a specific version in production to ensure consistent builds. | — | "" |
| properties_file | Path to properties file (relative to repository root) for defining variables in Checkstyle config. Use standard Java properties format (key=value) to centralize configuration values. | — | "" |
| exclude | Newline-separated list of directories or files to exclude from Checkstyle analysis. Paths are relative to the repository root. Uses Checkstyle's native -e flag. Subdirectories of excluded paths are also excluded. | — | "" |
Outputs
no outputs