hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Create the documentation about pmdtester

Browse Source
This commit is contained in:
BBG
2018-08-07 23:54:14 +08:00
committed by GitHub
parent 51a1ef1171
commit ee059422fd
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/pages/pmd/devdocs/pmdtester.md Normal file
View File

@ -0,0 +1,17 @@
## Introduction
Pmdtester is a regression testing tool ensure that new problems and unexpected behaviors will not be introduced to PMD project after fixing an issue ,
and new rules can work as expected. It has been integrated into travis CI and is actually used automatically for PRs.
Regression difference reports are commented back to the PR for the reviewer's information e.g. https://github.com/pmd/pmd/pull/1265#issuecomment-408945709
## Run pmdtester locally
**Install pmdtester**
`gem install pmdtester --pre`
**Verifying your local changes and generate a diff-report locally**
`pmdtester -r YOUR_LOCAL_PMD_GIT_REPO_ROOT_DIR -b master -p YOUR_DEVELOPMENT_BRANCH`
The regression difference report is placed in the `YOUR_WORKING_DIR/target/reports/diff` directory.
For more documentation on pmdtester, see [README.rdoc](https://github.com/pmd/pmd-regression-tester/blob/master/README.rdoc)