From ee059422fd92b7111779ba2505b80a78c1ff131c Mon Sep 17 00:00:00 2001 From: BBG Date: Tue, 7 Aug 2018 23:54:14 +0800 Subject: [PATCH 1/3] Create the documentation about pmdtester --- docs/pages/pmd/devdocs/pmdtester.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/pages/pmd/devdocs/pmdtester.md diff --git a/docs/pages/pmd/devdocs/pmdtester.md b/docs/pages/pmd/devdocs/pmdtester.md new file mode 100644 index 0000000000..37bdab229f --- /dev/null +++ b/docs/pages/pmd/devdocs/pmdtester.md @@ -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) From 01c622af10cf11db5282a4e61e2f79e8a920a885 Mon Sep 17 00:00:00 2001 From: BBG Date: Wed, 8 Aug 2018 10:35:52 +0800 Subject: [PATCH 2/3] fix comments --- docs/_data/sidebars/pmd_sidebar.yml | 3 +++ docs/pages/pmd/devdocs/pmdtester.md | 11 +++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/_data/sidebars/pmd_sidebar.yml b/docs/_data/sidebars/pmd_sidebar.yml index 760a09fc4f..7e01f5c0c4 100644 --- a/docs/_data/sidebars/pmd_sidebar.yml +++ b/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: diff --git a/docs/pages/pmd/devdocs/pmdtester.md b/docs/pages/pmd/devdocs/pmdtester.md index 37bdab229f..407ddd6de5 100644 --- a/docs/pages/pmd/devdocs/pmdtester.md +++ b/docs/pages/pmd/devdocs/pmdtester.md @@ -1,6 +1,13 @@ +--- +title: Pmdtester +tags: [devdocs] +permalink: pmd_devdocs_pmdtester.html +author: Binguo Bao +--- + ## 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. +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 From fb0e455e49ddd7f655d05f0fd896660a131bf7d0 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Wed, 8 Aug 2018 08:30:05 +0200 Subject: [PATCH 3/3] Update release notes, refs #1290 --- docs/pages/release_notes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md index c64d3d109d..77784fc832 100644 --- a/docs/pages/release_notes.md +++ b/docs/pages/release_notes.md @@ -52,3 +52,4 @@ This is a minor release. * [#1277](https://github.com/pmd/pmd/pull/1277): \[jsp] #1276 add support for jspf and tag extensions - [Jordi Llach](https://github.com/jordillachmrf) * [#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) +* [#1290](https://github.com/pmd/pmd/pull/1290): \[docs] \[GSoC] Create the documentation about pmdtester - [BBG](https://github.com/djydewang)