[maven-release-plugin] prepare release pmd_releases/6.19.0

[java] Rename rule InvalidSlf4jLoggingFormat to InvalidLogMessageFormat

.gitignore

@@ -13,3 +13,6 @@ bin/
 pmd-core/dependency-reduced-pom.xml
 .bundle
 vendor
+
+# rule docs are generated
+docs/pages/pmd/rules

.travis.yml

@@ -1,7 +1,3 @@
-addons:
-  ssh_known_hosts:
-    - web.sourceforge.net
-
 language: java
 
 env:
@@ -17,6 +13,8 @@ env:
 
 matrix:
   fast_finish: true
+  allow_failures:
+    - os: windows
   include:
     - name: "linux - mvn deploy"
       os: linux
@@ -37,16 +35,15 @@ matrix:
     - name: "macosx - mvn verify"
       os: osx
       env: BUILD=deploy
+    - name: "windows - mvn verify"
+      os: windows
+      env: BUILD=deploy
+      language: shell
 
 before_install:
-  - bash .travis/setup-secrets.sh
-  - bash .travis/configure-maven.sh
-  - rvm install 2.4.1
-  - rvm use 2.4.1
-install:
-  - . .travis/install-openjdk.sh
-  - gem install bundler
-  - bundle install --with=release_notes_preprocessing --path=vendor/bundle
+  - bash .travis/before_install.sh "11.0.5+10"
+  - source ${HOME}/java.env
+install: true
 before_script: true
 script: source .travis/build-$BUILD.sh
 after_success: true
@@ -61,10 +58,11 @@ deploy:
   - pmd-dist/target/pmd-*.zip
   - docs/pmd-doc-*.zip
   skip_cleanup: true
+  draft: true
   on:
     tags: true
     repo: pmd/pmd
-    condition: "${TRAVIS_SECURE_ENV_VARS} = true && ${BUILD} != sonar && ${BUILD} != coveralls"
+    condition: "${TRAVIS_SECURE_ENV_VARS} = true && ${BUILD} != sonar && ${BUILD} != coveralls && ${TRAVIS_OS_NAME} = linux"
 after_deploy: bash .travis/release.sh
 
 notifications:

.travis/before_install.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -e
+
+source .travis/logger.sh
+source .travis/common-functions.sh
+
+travis_debug
+
+OPENJDK_VERSION=$1
+
+bash .travis/setup-secrets.sh
+bash .travis/configure-maven.sh
+bash .travis/install-openjdk.sh $OPENJDK_VERSION
+
+
+if travis_isLinux; then
+    gem install bundler
+    bundle install --with=release_notes_preprocessing --path=vendor/bundle
+else
+    log_info "Not setting up ruby for ${TRAVIS_OS_NAME}."
+    exit 0
+fi

.travis/build-deploy.sh

@@ -4,29 +4,6 @@ set -e
 source .travis/logger.sh
 source .travis/common-functions.sh
 
-function push_docs() {
-    if git diff --quiet docs; then
-        log_info "No changes in docs..."
-    else
-        log_info "Found changes in docs..."
-
-        if [ "$TRAVIS_BRANCH" == "master" ]; then
-            git config user.name "Travis CI (pmd-bot)"
-            git config user.email "andreas.dangel+pmd-bot@adangel.org"
-            git add -A docs
-            MSG="Update documentation
-
-TRAVIS_JOB_NUMBER=${TRAVIS_JOB_NUMBER}
-TRAVIS_COMMIT_RANGE=${TRAVIS_COMMIT_RANGE}"
-            git commit -m "$MSG"
-            git push git@github.com:pmd/pmd.git HEAD:master
-            log_success "Successfully pushed docs update"
-        else
-            log_info "Not on master branch, won't commit+push"
-        fi
-    fi
-}
-
 function upload_baseline() {
     log_info "Generating and uploading baseline for pmdtester..."
     cd ..
@@ -55,6 +32,11 @@ if travis_isOSX; then
     log_info "The build is running on OSX"
     ./mvnw verify $MVN_BUILD_FLAGS
 
+elif travis_isWindows; then
+
+    log_info "The build is running on Windows"
+    ./mvnw verify $MVN_BUILD_FLAGS
+
 elif travis_isPullRequest; then
 
     log_info "This is a pull-request build"
@@ -80,7 +62,6 @@ elif travis_isPush; then
     elif [[ "${VERSION}" == *-SNAPSHOT ]]; then
         log_info "This is a snapshot build"
         ./mvnw deploy -Possrh,sign $MVN_BUILD_FLAGS
-        push_docs
     else
         # other build. Can happen during release: the commit with a non snapshot version is built, but not from the tag.
         log_info "This is some other build, probably during release: commit with a non-snapshot version on branch master..."

.travis/build-doc.sh

@@ -7,11 +7,27 @@ source .travis/common-functions.sh
 VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec)
 log_info "Building PMD Documentation ${VERSION} on branch ${TRAVIS_BRANCH}"
 
+#
+# First step: build pmd with profile "generate-rule-docs"
+# The docs should appear under "docs/pages/rules/..." for each language
+#
+./mvnw clean verify -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -P generate-rule-docs
+
+
+# in order to prevent that this documentation job is deploying the binary distributions to github releases
+# we delete it here
+
+rm -f pmd-dist/target/pmd-*.zip
+
+
+
 if ! travis_isPush; then
-    log_info "Not building site, since this is not a push!"
+    log_info "Not publishing site, since this is not a push!"
     exit 0
 fi
 
+
+
 pushd docs
 
 # run jekyll

.travis/common-functions.sh

@@ -2,15 +2,17 @@
 set -e
 
 
-echo "TRAVIS_REPO_SLUG: ${TRAVIS_REPO_SLUG}"
-echo "TRAVIS_PULL_REQUEST_SLUG: ${TRAVIS_PULL_REQUEST_SLUG}"
-echo "TRAVIS_PULL_REQUEST_BRANCH: ${TRAVIS_PULL_REQUEST_BRANCH}"
-echo "TRAVIS_PULL_REQUEST: ${TRAVIS_PULL_REQUEST}"
-echo "TRAVIS_SECURE_ENV_VARS: ${TRAVIS_SECURE_ENV_VARS}"
-echo "TRAVIS_BRANCH: ${TRAVIS_BRANCH}"
-echo "TRAVIS_TAG: ${TRAVIS_TAG}"
-echo "TRAVIS_ALLOW_FAILURE: ${TRAVIS_ALLOW_FAILURE}"
-echo "TRAVIS_OS_NAME: ${TRAVIS_OS_NAME}"
+function travis_debug() {
+    echo "TRAVIS_REPO_SLUG: ${TRAVIS_REPO_SLUG}"
+    echo "TRAVIS_PULL_REQUEST_SLUG: ${TRAVIS_PULL_REQUEST_SLUG}"
+    echo "TRAVIS_PULL_REQUEST_BRANCH: ${TRAVIS_PULL_REQUEST_BRANCH}"
+    echo "TRAVIS_PULL_REQUEST: ${TRAVIS_PULL_REQUEST}"
+    echo "TRAVIS_SECURE_ENV_VARS: ${TRAVIS_SECURE_ENV_VARS}"
+    echo "TRAVIS_BRANCH: ${TRAVIS_BRANCH}"
+    echo "TRAVIS_TAG: ${TRAVIS_TAG}"
+    echo "TRAVIS_ALLOW_FAILURE: ${TRAVIS_ALLOW_FAILURE}"
+    echo "TRAVIS_OS_NAME: ${TRAVIS_OS_NAME}"
+}
 
 function travis_isPullRequest() {
     if [ "${TRAVIS_REPO_SLUG}" != "pmd/pmd" ] || [ "${TRAVIS_PULL_REQUEST}" != "false" ]; then
@@ -36,6 +38,23 @@ function travis_isOSX() {
     fi
 }
 
+function travis_isLinux() {
+    if [[ $TRAVIS_OS_NAME == 'linux' ]]; then
+        return 0
+    else
+        return 1
+    fi
+}
+
+function travis_isWindows() {
+    if [[ $TRAVIS_OS_NAME == 'windows' ]]; then
+        return 0
+    else
+        return 1
+    fi
+}
+
+
 function has_docs_change() {
     if [[ $(git diff --name-only ${TRAVIS_COMMIT_RANGE}) = *"docs/"* ]]; then
         log_info "Checking for changes in docs/ (TRAVIS_COMMIT_RANGE=${TRAVIS_COMMIT_RANGE}): changes found"

.travis/install-openjdk.sh

@@ -1,27 +1,62 @@
+#!/bin/bash
+set -e
+
 #
 # AdoptOpenJDK Builds from:
 # https://github.com/AdoptOpenJDK/openjdk11-binaries/releases/tag/jdk-11.0.4%2B11
 #
 
-if [[ "$OSTYPE" == "darwin"* ]]; then
-    DOWNLOAD_URL=https://github.com/AdoptOpenJDK/openjdk11-binaries/releases/download/jdk-11.0.4%2B11/OpenJDK11U-jdk_x64_mac_hotspot_11.0.4_11.tar.gz
+source .travis/logger.sh
+source .travis/common-functions.sh
+
+# VERSION_TAG e.g. "11.0.4+11" or "13+33"
+VERSION_TAG=$1
+OPENJDK_MAJOR=${VERSION_TAG/.*/}
+OPENJDK_MAJOR=${OPENJDK_MAJOR/+*/}
+#BASE_URL=https://github.com/AdoptOpenJDK/openjdk${OPENJDK_MAJOR}-binaries/releases/download
+BASE_URL=https://pmd-code.org/openjdk
+
+log_info "Installing OpenJDK${OPENJDK_MAJOR}U ${VERSION_TAG} for ${TRAVIS_OS_NAME}"
+
+if travis_isOSX; then
+    DOWNLOAD_URL=${BASE_URL}/jdk-${VERSION_TAG/+/%2B}/OpenJDK${OPENJDK_MAJOR}U-jdk_x64_mac_hotspot_${VERSION_TAG/+/_}.tar.gz
     COMPONENTS_TO_STRIP=3 # e.g. jdk-11.0.3+7/Contents/Home/bin/java
+elif travis_isWindows; then
+    DOWNLOAD_URL=${BASE_URL}/jdk-${VERSION_TAG/+/%2B}/OpenJDK${OPENJDK_MAJOR}U-jdk_x64_windows_hotspot_${VERSION_TAG/+/_}.zip
 else
-    DOWNLOAD_URL=https://github.com/AdoptOpenJDK/openjdk11-binaries/releases/download/jdk-11.0.4%2B11/OpenJDK11U-jdk_x64_linux_hotspot_11.0.4_11.tar.gz
+    DOWNLOAD_URL=${BASE_URL}/jdk-${VERSION_TAG/+/%2B}/OpenJDK${OPENJDK_MAJOR}U-jdk_x64_linux_hotspot_${VERSION_TAG/+/_}.tar.gz
     COMPONENTS_TO_STRIP=1 # e.g. openjdk-11.0.3+7/bin/java
 fi
 
 OPENJDK_ARCHIVE=$(basename $DOWNLOAD_URL)
 
 LOCAL_DIR=${HOME}/.cache/openjdk
-TARGET_DIR=${HOME}/openjdk11
+TARGET_DIR=${HOME}/openjdk${OPENJDK_MAJOR}
 
 mkdir -p ${LOCAL_DIR}
 mkdir -p ${TARGET_DIR}
-wget --quiet --directory-prefix ${LOCAL_DIR} --timestamping --continue ${DOWNLOAD_URL}
-tar --extract --file ${LOCAL_DIR}/${OPENJDK_ARCHIVE} -C ${TARGET_DIR} --strip-components=${COMPONENTS_TO_STRIP}
+if [ ! -e ${LOCAL_DIR}/${OPENJDK_ARCHIVE} ]; then
+    log_info "Downloading from ${DOWNLOAD_URL} to ${LOCAL_DIR}"
+    wget --directory-prefix ${LOCAL_DIR} --timestamping --continue ${DOWNLOAD_URL}
+else
+    log_info "Skipped download, file ${LOCAL_DIR}/${OPENJDK_ARCHIVE} already exists"
+fi
 
-export JAVA_HOME=${TARGET_DIR}
-export PATH=${JAVA_HOME}/bin:$PATH
+log_info "Extracting to ${TARGET_DIR}"
+if travis_isWindows; then
+    7z x ${LOCAL_DIR}/${OPENJDK_ARCHIVE} -o${TARGET_DIR}
+    mv ${TARGET_DIR}/*/* ${TARGET_DIR}/
+else
+    tar --extract --file ${LOCAL_DIR}/${OPENJDK_ARCHIVE} -C ${TARGET_DIR} --strip-components=${COMPONENTS_TO_STRIP}
+fi
 
+cat > ${HOME}/java.env <<EOF
+export JAVA_HOME="${TARGET_DIR}"
+export PATH="${TARGET_DIR}/bin:${PATH}"
 java -version
+EOF
+
+log_info "OpenJDK can be used via ${HOME}/java.env"
+cat ${HOME}/java.env
+source ${HOME}/java.env
+

.travis/release.sh

@@ -28,38 +28,6 @@ if [ "${BUILD}" = "deploy" ]; then
     true
 )
 
-# renders, and skips the first 6 lines - the Jekyll front-matter
-RENDERED_RELEASE_NOTES=$(bundle exec .travis/render_release_notes.rb docs/pages/release_notes.md | tail -n +6)
-
-# Assumes, the release has already been created by travis github releases provider
-RELEASE_ID=$(curl -s -H "Authorization: token ${GITHUB_OAUTH_TOKEN}" https://api.github.com/repos/pmd/pmd/releases/tags/pmd_releases/${RELEASE_VERSION}|jq ".id")
-RELEASE_NAME="PMD ${RELEASE_VERSION} ($(date -u +%d-%B-%Y))"
-RELEASE_BODY="$RENDERED_RELEASE_NOTES"
-RELEASE_BODY="${RELEASE_BODY//'\'/\\\\}"
-RELEASE_BODY="${RELEASE_BODY//$'\r'/}"
-RELEASE_BODY="${RELEASE_BODY//$'\n'/\\r\\n}"
-RELEASE_BODY="${RELEASE_BODY//'"'/\\\"}"
-cat > release-edit-request.json <<EOF
-{
-  "name": "$RELEASE_NAME",
-  "body": "$RELEASE_BODY"
-}
-EOF
-log_info "Updating release at https://api.github.com/repos/pmd/pmd/releases/${RELEASE_ID}..."
-
-
-RESPONSE=$(curl -i -s -H "Authorization: token ${GITHUB_OAUTH_TOKEN}" -H "Content-Type: application/json" --data "@release-edit-request.json" -X PATCH https://api.github.com/repos/pmd/pmd/releases/${RELEASE_ID})
-if [[ "$RESPONSE" != *"HTTP/1.1 200"* ]]; then
-    log_error "Github Request failed!"
-    echo "Request:"
-    cat release-edit-request.json
-    echo
-    echo "Response:"
-    echo "$RESPONSE"
-else
-    log_success "Update OK"
-fi
-
 fi
 
 
@@ -107,6 +75,40 @@ mkdir pmd.github.io
     git push origin master
 )
 
+# renders, and skips the first 6 lines - the Jekyll front-matter
+RENDERED_RELEASE_NOTES=$(bundle exec .travis/render_release_notes.rb docs/pages/release_notes.md | tail -n +6)
+
+# Assumes, the release has already been created by travis github releases provider
+RELEASE_ID=$(curl -s -H "Authorization: token ${GITHUB_OAUTH_TOKEN}" https://api.github.com/repos/pmd/pmd/releases/tags/pmd_releases/${RELEASE_VERSION}|jq ".id")
+RELEASE_NAME="PMD ${RELEASE_VERSION} ($(date -u +%d-%B-%Y))"
+RELEASE_BODY="$RENDERED_RELEASE_NOTES"
+RELEASE_BODY="${RELEASE_BODY//'\'/\\\\}"
+RELEASE_BODY="${RELEASE_BODY//$'\r'/}"
+RELEASE_BODY="${RELEASE_BODY//$'\n'/\\r\\n}"
+RELEASE_BODY="${RELEASE_BODY//'"'/\\\"}"
+cat > release-edit-request.json <<EOF
+{
+  "name": "$RELEASE_NAME",
+  "body": "$RELEASE_BODY",
+  "draft": false
+}
+EOF
+echo -e "\n\n"
+log_info "Updating and publishing release at https://api.github.com/repos/pmd/pmd/releases/${RELEASE_ID}..."
+
+
+RESPONSE=$(curl -i -s -H "Authorization: token ${GITHUB_OAUTH_TOKEN}" -H "Content-Type: application/json" --data "@release-edit-request.json" -X PATCH https://api.github.com/repos/pmd/pmd/releases/${RELEASE_ID})
+if [[ "$RESPONSE" != *"HTTP/1.1 200"* ]]; then
+    log_error "Github Request failed!"
+    echo "Request:"
+    cat release-edit-request.json
+    echo
+    echo "Response:"
+    echo "$RESPONSE"
+else
+    log_success "Update OK"
+fi
+
 
 
 (

.travis/setup-secrets.sh

@@ -22,3 +22,26 @@ mkdir -p "$HOME/.gpg"
 gpg --batch --import .travis/release-signing-key-82DE7BE82166E84E.gpg
 rm .travis/secrets.tar
 rm .travis/release-signing-key-82DE7BE82166E84E.gpg
+
+echo "Setting up .ssh/known_hosts..."
+#
+# https://sourceforge.net/p/forge/documentation/SSH%20Key%20Fingerprints/
+#
+# run locally:
+# ssh-keyscan web.sourceforge.net | tee -a known_hosts
+#
+# verify fingerprints:
+# ssh-keygen -F web.sourceforge.net -l -f known_hosts 
+# # Host web.sourceforge.net found: line 1 
+# web.sourceforge.net RSA SHA256:xB2rnn0NUjZ/E0IXQp4gyPqc7U7gjcw7G26RhkDyk90 
+# # Host web.sourceforge.net found: line 2 
+# web.sourceforge.net ECDSA SHA256:QAAxYkf0iI/tc9oGa0xSsVOAzJBZstcO8HqGKfjpxcY 
+# # Host web.sourceforge.net found: line 3 
+# web.sourceforge.net ED25519 SHA256:209BDmH3jsRyO9UeGPPgLWPSegKmYCBIya0nR/AWWCY 
+#
+# then add output of `ssh-keygen -F web.sourceforge.net -f known_hosts`
+#
+echo 'web.sourceforge.net ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA2uifHZbNexw6cXbyg1JnzDitL5VhYs0E65Hk/tLAPmcmm5GuiGeUoI/B0eUSNFsbqzwgwrttjnzKMKiGLN5CWVmlN1IXGGAfLYsQwK6wAu7kYFzkqP4jcwc5Jr9UPRpJdYIK733tSEmzab4qc5Oq8izKQKIaxXNe7FgmL15HjSpatFt9w/ot/CHS78FUAr3j3RwekHCm/jhPeqhlMAgC+jUgNJbFt3DlhDaRMa0NYamVzmX8D47rtmBbEDU3ld6AezWBPUR5Lh7ODOwlfVI58NAf/aYNlmvl2TZiauBCTa7OPYSyXJnIPbQXg6YQlDknNCr0K769EjeIlAfY87Z4tw==' >> "$HOME/.ssh/known_hosts"
+echo 'web.sourceforge.net ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBCwsY6sZT4MTTkHfpRzYjxG7mnXrGL74RCT2cO/NFvRrZVNB5XNwKNn7G5fHbYLdJ6UzpURDRae1eMg92JG0+yo=' >> "$HOME/.ssh/known_hosts"
+echo 'web.sourceforge.net ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOQD35Ujalhh+JJkPvMckDlhu4dS7WH6NsOJ15iGCJLC' >> "$HOME/.ssh/known_hosts"
+

Gemfile.lock

@@ -0,0 +1,86 @@
+GIT
+  remote: https://github.com/pmd/pmd-regression-tester.git
+  revision: 8e652477b3547d6c843864a2641389a4c61c383e
+  specs:
+    pmdtester (1.0.0.pre.SNAPSHOT)
+      differ
+      nokogiri (~> 1.8.2)
+      rufus-scheduler (~> 3.5, >= 3.5)
+      slop (~> 4.6.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    colored2 (3.1.2)
+    concurrent-ruby (1.1.5)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.16.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1.5)
+      kramdown (~> 1.5)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    differ (0.1.2)
+    et-orbi (1.2.2)
+      tzinfo
+    faraday (0.16.2)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    fugit (1.3.3)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.1)
+    git (1.5.0)
+    kramdown (1.17.0)
+    liquid (4.0.3)
+    mini_portile2 (2.3.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    no_proxy_fix (0.1.2)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    public_suffix (4.0.1)
+    raabro (1.1.6)
+    rouge (3.11.0)
+    rufus-scheduler (3.6.0)
+      fugit (~> 1.1, >= 1.1.6)
+    safe_yaml (1.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    slop (4.6.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    tzinfo (2.0.0)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  danger (~> 5.6, >= 5.6)
+  liquid (>= 4.0.0)
+  pmdtester!
+  rouge (>= 1.7, < 4)
+  safe_yaml (>= 1.0)
+
+BUNDLED WITH
+   2.0.1

LICENSE

@@ -235,171 +235,3 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-
----------------------------------------------------------------------
-
-                   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.

NOTICE

@@ -6,7 +6,3 @@ for more info see http://pmd.sourceforge.net/license.html or LICENSE
 Part of this product (mostly the package net.sourceforge.pmd.lang.vm)
 is licensed under the Apache License, Version 2.0;
 for more info see http://www.apache.org/licenses/LICENSE-2.0 or LICENSE
-
-Part of this product (part of pmd-scala)
-is licensed under the GNU Lesser General Public License, Version 3 or later
-for more info see http://www.gnu.org/licenses/lgpl.txt or LICENSE

README.md

@@ -8,8 +8,8 @@
 ## About
 
 **PMD** is a source code analyzer. It finds common programming flaws like unused variables, empty catch blocks,
-unnecessary object creation, and so forth. It supports Java, JavaScript, Salesforce.com Apex and Visualforce, PLSQL, Apache Velocity,
-XML, XSL.
+unnecessary object creation, and so forth. It supports Java, JavaScript, Salesforce.com Apex and Visualforce,
+PLSQL, Apache Velocity, XML, XSL, Scala.
 
 Additionally it includes **CPD**, the copy-paste-detector. CPD finds duplicated code in
 C/C++, C#, Dart, Fortran, Go, Groovy, Java, JavaScript, JSP, Kotlin, Lua, Matlab,

do-release.sh

@@ -112,11 +112,13 @@ fi
 
 git commit -a -m "Prepare pmd release ${RELEASE_VERSION}"
 (
-    echo "Committing current changes (pmd.github.io)"
     cd ../pmd.github.io
     git add ${RELEASE_NOTES_POST}
-    git commit -a -m "Prepare pmd release ${RELEASE_VERSION}"
-    git push
+    changes=$(git status --porcelain 2>/dev/null| egrep "^[AMDRC]" | wc -l)
+    if [ $changes -gt 0 ]; then
+        echo "Committing current changes (pmd.github.io)"
+        git commit -a -m "Prepare pmd release ${RELEASE_VERSION}" && git push
+    fi
 )
 
 ./mvnw -B release:clean release:prepare \

docs/Gemfile.lock

@@ -1,13 +1,13 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.10)
+    activesupport (4.2.11.1)
       i18n (~> 0.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
@@ -15,39 +15,39 @@ GEM
     colorator (1.1.0)
     commonmarker (0.17.13)
       ruby-enum (~> 0.5)
-    concurrent-ruby (1.1.3)
-    dnsruby (1.61.2)
+    concurrent-ruby (1.1.5)
+    dnsruby (1.61.3)
       addressable (~> 2.5)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
-    ethon (0.11.0)
+    ethon (0.12.0)
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
     execjs (2.7.0)
-    faraday (0.15.3)
+    faraday (0.16.2)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.25)
+    ffi (1.11.1)
     forwardable-extended (2.6.0)
-    gemoji (3.0.0)
-    github-pages (193)
-      activesupport (= 4.2.10)
-      github-pages-health-check (= 1.8.1)
-      jekyll (= 3.7.4)
+    gemoji (3.0.1)
+    github-pages (200)
+      activesupport (= 4.2.11.1)
+      github-pages-health-check (= 1.16.1)
+      jekyll (= 3.8.5)
       jekyll-avatar (= 0.6.0)
       jekyll-coffeescript (= 1.1.1)
       jekyll-commonmark-ghpages (= 0.1.5)
       jekyll-default-layout (= 0.1.4)
       jekyll-feed (= 0.11.0)
       jekyll-gist (= 1.5.0)
-      jekyll-github-metadata (= 2.9.4)
+      jekyll-github-metadata (= 2.12.1)
       jekyll-mentions (= 1.4.1)
       jekyll-optional-front-matter (= 0.3.0)
       jekyll-paginate (= 1.1.0)
       jekyll-readme-index (= 0.2.0)
       jekyll-redirect-from (= 0.14.0)
-      jekyll-relative-links (= 0.5.3)
-      jekyll-remote-theme (= 0.3.1)
+      jekyll-relative-links (= 0.6.0)
+      jekyll-remote-theme (= 0.4.0)
       jekyll-sass-converter (= 1.5.2)
       jekyll-seo-tag (= 2.5.0)
       jekyll-sitemap (= 1.2.0)
@@ -66,28 +66,28 @@ GEM
       jekyll-theme-tactile (= 0.1.1)
       jekyll-theme-time-machine (= 0.1.1)
       jekyll-titles-from-headings (= 0.5.1)
-      jemoji (= 0.10.1)
+      jemoji (= 0.10.2)
       kramdown (= 1.17.0)
       liquid (= 4.0.0)
       listen (= 3.1.5)
       mercenary (~> 0.3)
       minima (= 2.5.0)
-      nokogiri (>= 1.8.2, < 2.0)
+      nokogiri (>= 1.10.4, < 2.0)
       rouge (= 2.2.1)
       terminal-table (~> 1.4)
-    github-pages-health-check (1.8.1)
+    github-pages-health-check (1.16.1)
       addressable (~> 2.3)
       dnsruby (~> 1.60)
       octokit (~> 4.0)
-      public_suffix (~> 2.0)
+      public_suffix (~> 3.0)
       typhoeus (~> 1.3)
-    html-pipeline (2.9.1)
+    html-pipeline (2.12.0)
       activesupport (>= 2)
       nokogiri (>= 1.4)
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.7.4)
+    jekyll (3.8.5)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -105,9 +105,9 @@ GEM
     jekyll-coffeescript (1.1.1)
       coffee-script (~> 2.2)
       coffee-script-source (~> 1.11.1)
-    jekyll-commonmark (1.2.0)
+    jekyll-commonmark (1.3.1)
       commonmarker (~> 0.14)
-      jekyll (>= 3.0, < 4.0)
+      jekyll (>= 3.7, < 5.0)
     jekyll-commonmark-ghpages (0.1.5)
       commonmarker (~> 0.17.6)
       jekyll-commonmark (~> 1)
@@ -118,8 +118,8 @@ GEM
       jekyll (~> 3.3)
     jekyll-gist (1.5.0)
       octokit (~> 4.2)
-    jekyll-github-metadata (2.9.4)
-      jekyll (~> 3.1)
+    jekyll-github-metadata (2.12.1)
+      jekyll (~> 3.4)
       octokit (~> 4.0, != 4.4.0)
     jekyll-mentions (1.4.1)
       html-pipeline (~> 2.3)
@@ -131,9 +131,10 @@ GEM
       jekyll (~> 3.0)
     jekyll-redirect-from (0.14.0)
       jekyll (~> 3.3)
-    jekyll-relative-links (0.5.3)
+    jekyll-relative-links (0.6.0)
       jekyll (~> 3.3)
-    jekyll-remote-theme (0.3.1)
+    jekyll-remote-theme (0.4.0)
+      addressable (~> 2.0)
       jekyll (~> 3.5)
       rubyzip (>= 1.2.1, < 3.0)
     jekyll-sass-converter (1.5.2)
@@ -185,9 +186,9 @@ GEM
       jekyll-seo-tag (~> 2.0)
     jekyll-titles-from-headings (0.5.1)
       jekyll (~> 3.3)
-    jekyll-watch (2.1.2)
+    jekyll-watch (2.2.1)
       listen (~> 3.0)
-    jemoji (0.10.1)
+    jemoji (0.10.2)
       gemoji (~> 3.0)
       html-pipeline (~> 2.2)
       jekyll (~> 3.0)
@@ -198,37 +199,37 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     mercenary (0.3.6)
-    mini_portile2 (2.3.0)
+    mini_portile2 (2.4.0)
     minima (2.5.0)
       jekyll (~> 3.5)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.11.3)
-    multipart-post (2.0.0)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
-    octokit (4.13.0)
+    minitest (5.12.2)
+    multipart-post (2.1.1)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    octokit (4.14.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (2.0.5)
+    public_suffix (3.1.1)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rouge (2.2.1)
     ruby-enum (0.7.2)
       i18n
     ruby_dep (1.5.0)
-    rubyzip (1.2.2)
-    safe_yaml (1.0.4)
-    sass (3.7.2)
+    rubyzip (2.0.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
@@ -236,7 +237,7 @@ GEM
       ethon (>= 0.9.0)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -246,4 +247,4 @@ DEPENDENCIES
   jekyll
 
 BUNDLED WITH
-   1.16.2
+   1.17.3

docs/_config.yml

@@ -1,9 +1,9 @@
 repository: pmd/pmd
 
 pmd:
-    version: 6.17.0
-    previous_version: 6.16.0
-    date: 28-July-2019
+    version: 6.19.0
+    previous_version: 6.18.0
+    date: 31-October-2019
     release_type: minor
 
 # release types: major, minor, bugfix

docs/_data/sidebars/pmd_sidebar.yml

@@ -67,6 +67,9 @@ entries:
         - title: Writing XPath rules
           url: /pmd_userdocs_extending_writing_xpath_rules.html
           output: web, pdf
+        - title: Rule designer reference
+          url: /pmd_userdocs_extending_designer_reference.html
+          output: web, pdf
         - title: Defining rule properties
           url: /pmd_userdocs_extending_defining_properties.html
           output: web, pdf

docs/_plugins/details_block.rb

@@ -0,0 +1,22 @@
+# Mimics an HTML <details> element
+# Courtesy of https://github.com/towbi (https://gist.github.com/towbi/a67fda47e075d2b7fa4764bb42605063)
+class DetailsTag < Liquid::Block
+
+  def initialize(tag_name, markup, tokens)
+    super
+    @caption = markup
+  end
+
+  def render(context)
+    site = context.registers[:site]
+    converter = site.find_converter_instance(::Jekyll::Converters::Markdown)
+    # below Jekyll 3.x use this:
+    # converter = site.getConverterImpl(::Jekyll::Converters::Markdown)
+    caption = converter.convert(@caption).gsub(/<\/?p[^>]*>/, '').chomp
+    body = converter.convert(super(context))
+    "<details><summary>#{caption}</summary>#{body}</details>"
+  end
+
+end
+
+Liquid::Template.register_tag('details', DetailsTag)

docs/css/pmd-customstyles.css

@@ -19,4 +19,36 @@
     top: 50px; /* height of the nav bar */
     bottom: 0px;
     width: 100%;
-}
+}
+
+details {
+    border-radius: 3px;
+    background: #EEE;
+    margin-left: 10px;
+}
+
+details p {
+    padding: 5px 10px 5px;
+    background: white;
+}
+
+details summary {
+    font-size: 11pt;
+    vertical-align: top;
+    background: #d2d2d2;
+    color: black;
+    border-radius: 3px;
+    padding: 5px 10px;
+    outline: none;
+    cursor: pointer;
+    display: list-item;
+}
+
+details summary::after {
+    content: "...";
+}
+
+details[open] summary {
+    background-color: #347DBE;
+    color: white;
+}