Download the PHP package mridang/pmd-annotations without Composer
On this page you can find all versions of the php package mridang/pmd-annotations. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mridang/pmd-annotations
More information about mridang/pmd-annotations
Files in mridang/pmd-annotations
Package pmd-annotations
Short Description Turns PMD style XML reports into Github pull-request annotations via the Checks API. This script is meant for use within your Github Action.
License MIT
Informations about the package pmd-annotations
Annotate pull-requests based on a PMD XML-report
Turns PMD style 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 have to search through your Github Action log files or the console output. 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.
Images from https://github.com/mheap/phpunit-github-actions-printer
Installation
Install the binary via Composer
Example Usage
pmd2pr
can be used on a already existing PMD-report XML-report. Alternatively you might use it in the UNIX pipe notation to chain it into your existing cli command.
Run one of the following commands within your Github Action workflow:
Process a PMD formatted file
Available Options
--graceful-warnings
: Don't exit with error codes if there are only warnings--colorize
: Colorize the output. Useful if the same lint script should be used locally on the command line and remote on Github Actions. With this option, errors and warnings are better distinguishable on the command line and the output is still compatible with Github annotations
Pipe the output of another commmand
This works for any command which produces a PMD-formatted report. Examples can bee seen below:
Using PHPMD
Example GithubAction workflow
If you're using shivammathur/setup-php
to setup PHP, pmd2pr
binary is shipped within:
If you use a custom PHP installation, then your project needs to require mridang/pmd-annotations
Resources
All versions of pmd-annotations with dependencies
ext-simplexml Version *