i05nagai/GitHub PR Review from Checkstyle
Post checkstyle XML violations as inline GitHub pull request review comments
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| checkstyle-file | Path to the checkstyle XML report file, relative to $GITHUB_WORKSPACE. Example: checkstyle-result.xml or build/reports/checkstyle/main.xml | yes | — |
| pull-request-number | Pull request number to post comments on. Example: ${{ github.event.pull_request.number }} | yes | — |
| github-token | GitHub token with pull-requests: write permission | no | ${{ github.token }} |
| strip-prefix | Path prefix to strip from the absolute file paths emitted by checkstyle before matching them against the PR file list. Example: ${{ github.workspace }}/ | no | "" |
| dry-run | Set to "true" to print the review JSON to the workflow log instead of posting it to GitHub. Useful for debugging path-matching issues. | no | false |
Outputs
no outputs