Merge branch 'pr-1290'

docs/_data/sidebars/pmd_sidebar.yml

@@ -325,6 +325,9 @@ entries:
     - title: How PMD works
       url: /pmd_devdocs_how_pmd_works.html
       output: web, pdf
+    - title: Pmdtester
+      url: /pmd_devdocs_pmdtester.html
+      output: web, pdf
     - title: null
       output: web, pdf
       subfolders:

docs/pages/pmd/devdocs/pmdtester.md

@@ -0,0 +1,24 @@
+---
+title: Pmdtester
+tags: [devdocs]
+permalink: pmd_devdocs_pmdtester.html
+author: Binguo Bao <djydewang@gmail.com>
+---
+
+## Introduction
+Pmdtester is a regression testing tool that ensures no new problems and unexpected behaviors will be introduced to PMD after fixing an issue. 
+It can also be used to verify, that new rules 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)

docs/pages/release_notes.md

@@ -54,3 +54,4 @@ This is a minor release.
 *   [#1275](https://github.com/pmd/pmd/pull/1275): \[jsp] Issue #1274 - Support EL in tag attributes - [Jordi Llach](https://github.com/jordillachmrf)
 *   [#1278](https://github.com/pmd/pmd/pull/1278): \[ci] \[GSoC] Use pmdtester 1.0.0.pre.beta3 - [BBG](https://github.com/djydewang)
 *   [#1289](https://github.com/pmd/pmd/pull/1289): \[java] UselessParentheses: Fix false positive with assignments - [cobratbq](https://github.com/cobratbq)
+*   [#1290](https://github.com/pmd/pmd/pull/1290): \[docs] \[GSoC] Create the documentation about pmdtester - [BBG](https://github.com/djydewang)