cs2pr - Annotate a GitHub Pull Request based on a Checkstyle XML-report within your GitHub Action

cs2pr turns checkstyle based XML-Reports into GitHub Pull Request Annotations via the Checks API. This script is meant for use within your GitHub Action.

That means you no longer search thru your GitHub Action logfiles. No need to interpret messages which are formatted differently with every tool. Instead you can focus on your Pull Request, and you don’t need to leave the Pull Request area.

Logs Example

Context Example Images from https://github.com/mheap/phpunit-github-actions-printer

DEMO - See how Pull Request warnings/errors are rendered in action

Usage

see the GitHub Readme for a in-detail description

Found a bug? Please help improve this article.

<
Previous Post
Achievement unlocked: 75 PHPStan pull requests merged
>
Next Post
phpstan-dba static analysis