Fix toc links

(cherry picked from commit 40f0c4d59b)

.gitattributes

@@ -0,0 +1,14 @@
+*       text=auto
+*.java  text
+*.xml   text
+*.jjt   text
+*.jj    text
+*.g4    text
+*.md    text
+*.sh    text eol=lf
+*.bat   text eol=crlf
+mvnw.cmd text eol=crlf
+*.png   -text
+*.jpg   -text
+*.svgz  -text
+*.jar   -text

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+<!-- Please, prefix the report title with the language it applies to within brackets, such as [java] or [apex].
+If not specific to a language, you can use [core]. -->
+
+**Affects PMD Version:** 
+
+**Rule:**
+
+**Description:**
+
+**Code Sample demonstrating the issue:**
+
+```
+
+```
+
+**Running PMD through:** *[CLI | Ant | Maven | Gradle | Designer | Other]*
+
+<!-- If relevant, also include your JDK and OS information, e.g. for ClassNotFoundException, LinkageError, reflection failures, etc. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+Please, prefix the PR title with the language it applies to within brackets, such as *[java]* or *[apex]*. If not specific to a language, you can use *[core]*
+
+Before submitting a PR, please check that:
+ - [ ] The PR is submitted against `master`. The PMD team will merge back to support branches as needed.
+ - [ ] `./mvnw test` passes.
+ - [ ] `./mvnw pmd:check` passes.
+ - [ ] `./mvnw checkstyle:check` passes. [Check this for more info](https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md#code-style)
+
+**PR Description:**
+

.gitignore

@@ -10,3 +10,4 @@ bin/
 .idea
 *.patch
 */src/site/site.xml
+pmd-core/dependency-reduced-pom.xml

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1 @@
+distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.4/apache-maven-3.5.4-bin.zip

.travis.yml

@@ -0,0 +1,94 @@
+dist: trusty
+sudo: false
+addons:
+  ssh_known_hosts:
+    - web.sourceforge.net
+
+language: java
+
+env:
+  global:
+  - secure: KBEuB6U1p5RQXSYe157AwydFr/zpXQPA0IChVCgZV+X1mMyy9ZtrjH1J1AXuviseDDXDbaT25sRnsvpl82rfRw2xOkMGXHy4N95/ylTSr8DjHxTao71BhXsvFycNobFva5y2EGNWqDvpS8I2oSZo7Qk4la3yep3rcJQvcy6RDbbhpDTbL1QMFyadunIBm0WtqbunrMqtjSqaoPsXz8TiQuxHvX4vEXzVbaxV1QQt79Vi+daa6wAV3mRQAugnx+UffsC8JqMxgm06usWeJgCJzxgm8E7clZCLmf53B2TL8dK6bIYbqyvOY3uFxitsTG0d8Z0GOJwXBgZNgbniTRO8ZJSty5eZP8LBybbjVLSL25DNTWtCjADUL/uySnXIEidlMt2N/3QmH7zrGAfAk/tIwKpdRca2GLLydeXf6PSkiahnPEkIY/QupcsOLELhdifpdOjb8QW1OenA+vUbNM9dccLwKnX6Fj9cu4VQG601AcYDr2eyhq8WYkr3wYdw/6KdUa3hmplowTBs+qguppP+eOSgGuEsy38KLtqnvm6WlHy6tcLmcVYKG3DmR1b7TWXsOXC6/VMH8BHBkvsF1QdRg9+Cgx07vX3Hw7roPiYzmaO9Ajs20ATsUfRskMuWCTeTSK5pN8X27veRCZlhFjeKQMDdmfVwzpAfRgKsl3TEn1I=
+  - secure: U1DfAv6acUUWe+dao/ZSDUX64JRadNJY16rITsdrM4ZNAJSuXpEY3p/LWcYjN7D49YmyutbXH9+L3KKQUQGrGXj9QTarfYvd8ZsKt4FK8yv7AFy+RQNIbAjNEHBzHx15p+srMheTaetl7aLwY0qhF+D/RtGapxHKyY4dBHrb0lp8VGyiCiL7Aop8GGskosi1mtirPBp/BStPZ2bEyxG0QzU5SsVWkJWwV9aWLPVAR/n7Xgx/6Gjl6Fed2c/WSrWi4vchm3Ny8pfTweOax3PGYYjBVxIfuX0mqmwuJsY7gNfXCfN3dPiPKGJPFy1pC+LGyGkklO5ReKFLd4O1ME6fU0dlIGfD6n+Q4H6/w9FHXegcKTfWIJm/MFa6vA/tJM5R6zJQuiTQJboHm/UmS/iQj76z0p6sK15Xp5vFId+/dHKqa8xY+Bt6HiXy6z401HOc8QcYBAf7TqhqUt/ZE7HN4be46uR90KmzIrWz6wEoDW7HfwQ9ZMbs55zoOXrvekyE9/gXskypO0p2JT3Y0vlvO27KQvIrSwI480kOVOrlyrYA+LZqlcKaayOuCuZh4lITQUYinUoZZict5joYthH+Cyh2zovoBpxsntDJdMnaZNLtSC7hlhpbMBYaT2y1O6vZH5Yix0mxuDvs/x6ogP5CNBeUYlXhaL+g4GnwKyr0ZA0=
+  - secure: "ElWjttpoMwqezP2zyHkx7CiPON/mRLUW7SsSlEqdlTUYRIaSaL7sShUORJUzj58U/Nnfi/eY4Rweo0CtVu20sG16s9B4adnmPS44LAitztybPR/co93gN9qb8jiIl41nVcOJq+Rut2Z4nr8AGRhVCG9Drg4+DreCqQ4DE5ZD6J99GN0IFGrREt59HQUlBlT9jD0AndK/1GQ6kWAenuSREE2P5ih59rf6FrrfddQO5iqyFFoaHek3JiOmpaLK+z7i4EvMKsAJEooFNuGhHVuyaJJRRZHAncGiQ+uW/yL7G5rY51G6YSNJczzEtfrRg+YrIUbokUPmifSIbnXO/AIZRAq1dMhA8exRc5n+75RB1X164qm4a+yggdybFBh0L59xu606PJQJAuWy+x10nled7FAVXiotxbB0r2bhlVmWFEN+FWPqXg2rVkHvw6+5PM67rG5g1LCgjKzb9I6JWPiVI+EMn8Pw8gryL2Sdqtl08Da0Ypbl2ZK/afU4CEPEKnrDc9ecXKjacehTYwGS48V213XvArcmoEpsyZDRSMTrvK3/e29GEaxoK/ZzWJylpeOtsICEEFYEBEiDsiIW4C50MIUPT2xHV6MaPQzhkuwrbQ6QFYzHzihBaiQuMmXUQ4DMb3fOPkNZAQHQo8CgJ78IcbCABAoGv9mu/fo2KoLo11U="
+  - secure: "otZkFNhApMofp2Jl2baZdpNEPcTa79Xc9wyOw1gl1+ubCLtOGr32FDUSr0HQWKrGXcYZR4bc0A80hx0/ykZ/twJaRAabcNYtjwRMDKKrp3plvp8RTZlB1QW85nsdmk3qmHACzc94wKnmcaDohM5FPxnWspZG5Y4ejYX4HEK6r1fwL4FjMPSLd5QW8yCaAc7dpBSm2UyIXuuDjkekXblJFe8ydbf9aF97WKJMCwqIs9Zo5oJa2pnWCw47ixwjVdkaH5x5727I+YmFqn5rjdEideUFEAlggqMaxuOtfYhuG/8k5W3Q/+WX+G7rEPTcemjmaosbbpoOUE0YUHV3Wi3R5D66NuWIpQwX6kw4rTwL0YIh//0aNb8jv4Z8KwkiTMrYuj0we5tXzARp3yYn56P0JBAm6BihNhfEBv06655Tg5LUsWqUTZCl3KJhwtO1N+OuOkE5qoZm59knq6DeZOsYWAVb3MpzklP06kXGYTjb44PVMUc6ynuuZjgPJDv/0906feA3REHBJVxd3PvJp1c8VvQSeW3ndghEz0akJHY/jxV1rJZAZC1ZeshYUpBNmh0sFDty/UE43IvIB4EInypQHyTtQvMc6LuLjTeu2E5ZMsA3udj66EMrYm4Y2eheJycSfttDqzhsKXIVJ4LmA/xtDR01cp1jsqbbZBhVI67rA40="
+  - secure: "mmHRnK/8CHfgtwaTN3MgjFD1R8EVQhIb/a0Aag3gPaHWW52Ex6xWG7GsF4kRcdzHdIdrQxHZTiDa2oVMWbnQ16CAu4dZJadwTxhBW4JmE1tsi2C6i+uwMBPvnKBXHwt+QOAqNB0L/ByYwWLkucSLoyRs6qU0i7sJ3ZC/EPCuLI8VfBlFUVegSbp2WmclmFnxOi5MKr15Zwd8BGgyWUsvd1OHxhvO3Xr/ZPO4R+1kIgyojloTMu6oGM/shYgsrUXgmI/WvZRTq+25SRCjUmATJtuDXXgVeJtYabi/+Zju5Z7K06oaKvFYM+BgZWPmGQkVCxKVjSlug0rx6+qgRKIf/B/cPxmQDS0ZZVDmDcbxeibBL9JhRqIDwDb0XS9t1qBXvIJ5E4ZmdX/XuvLCnC4xJptu/vHyKl1wbRM3dcXEBk8J0knJc4JvY2yupF3LS32sfEHftLwzr63U3/0dOQvsCSJRBy5zgI8ieABUZAeZmmaQ6RCGOTEYrGO2G4CCF2uVq4YdrCOsfmrb0DzH8llNMkXKzXlITRvmkuBlTRRKxGnPzS3vf0iicdAkmTiU5u7lArFFc7IKcW4ypO+RKDTUpq74K+UZBI9eBjV7Po368EO8epJ5aIx32a2kyS/hYWkS/dZh7I0fNZa2qBUceZO/KZGRjH4dQFW9t0J9Q7LLXJY="
+  - secure: "geOU/7VR83KYTOCR5XkgFqnHJEnXeB6hNDE7UFcN4ZsL9uVLhxlDVWV3ujJ87nyBzggG1KfSnUx11UwOQrbBl0K6sEXo/B2q5ytOsWoSLi7+0qm/uhhw/DTBOq57p8TIDKFM7rDhO7uajSn7Y86LeZkh9wIs5265Fh1yhCkiPbczDUMsX4P0GGg2qgkIKSBw4DZf6sPDc4xjJq/4/cLnjXo/K0ZYAIoSLqDfe1gmkzMtQlad+1t8Lwv/gOJ4BNRF4a5aEvGF6kbFovFoeFWCQTKlkn6VJtY+BETGKW2RH9efGeMs7JbBbNm+nnpoNsbJ0gdmGlhSbWT8enIm72/P0ThTBJWVcLJ30tUd0UeYD9C49wbJ3RHSxsoUKP9YhHJ+XKNx+8irkJ8LPCkNMQEFE153gEVvU7tCgah9Uq6laYZv9cQE0dWzNt3//Ymls8BzY38Ha4PbrIIJqEuWwnAX6ZgTgzVtXx1AJjkDFG9KFKPhN7NfNMbh7rn5C84a1h5zrIydm+6RcIBC+xTLDEiN7djiquf3PcNtyGLcO8dNN4Uv8iU0Jw8ch3+w0PJO53v5py+IS1V8pwwYaYF2iVPOoziS0tP8MsgYVGwpTZhvz3v8x0ge8r6KJE4zdvoPtCRNr2Oo3sJGYqkt86Hu6agKFiljP5AgJNx7iQD5GQn6J3w="
+  - secure: "gqyPF3d75JuwZptnQQQKO6rGUILXGO09y9dZhShdX8qq5Mexa2ISk77Y/b0yyAdhJMgEglls5cWlbHkwCAB0i4yL25RE5CtQUe4er+CIKwBIs0M56ghbcOwWAFB/cXeyyWmXDHBVnVUeKm7IJ34txsEclnMzQSR/DInSzsCFMUQok8HEaWZNssMjyRgo6goKGdG5vNWGfLLY7mKGMe/6PpYJD0G8k+Na08aX06ZWph38He8O3imUAngoQrxiSp0UYmnHDkigbV7S2LdZOsj7kMxkiyigzK/P1eygHVbFAhohLroaqS9B4CBK7QeOyup2vxVKqJVzFwOCylD0786CImvaG2ZYMtvJkapvaEE0mdMlyYpHgdIkmHZu28aMW7hXEhxHyBAxKuPcj5eGCGziO+ztCvfYIA9CGs1uA4KLrED7SahvB0oXnt3KTFdRc857cWcpp2NmRKihLzVdgHlmT8zcYaec3zP1VdMoa2bmLHoaZtAwvMTcAG56FcET1p7f9v+uiU88ZeptEjTJfpAWlq34tpwZXNyIQi5IROocSHM+PKTgLAsAMP5klGascr8E0sEzREl7tg8hqEwXKym/sVKyT+HMptA3UZcrZZhm07/cmQ0pUVvbV9QDb0MzU3O2wF7vT3U7R7Fb1u0LxMjblPyEazTp8ldabVRJREwlsDc="
+  - secure: "JIhuqaI0i+zvuqqXiQBHpuKr7AQ8jfk6Gbr8Qgiq4yJtdEWXZGxnAT9BmlbjkgT7ABXvLgxf2CIdUOMo1yYfBlxQL/y5+e89jaVpYF3tvNAzYQ1e12VzQRsd/jDb7qvm7tw3rDHEn3dSEot7Q6KbPcL6WzWJINVMCCmOgvq9gKHgE6Y5q5EgZ5rxiXyuO27ndzcbxaor4PIaiSzHO9+AJQ7p2zDLP+kG4nKVTBX0l9VoKiYFhIpIhpbigi3jyLDMDRiWpwTWZC6P8/RXfZg/lc5ADOuM2DM8oXPpZuqOa/g31LWQOSCuEnQ1G16vbLgipSPpgAc7jYWD5cywhG9dLkiKaZDh5x0meLM2RoAgz6eAnQfTTqJ68OM9o9yXjubEedsNpNRAr9/DXMd+fbh10W2vbvL5HCNB3lic3anehhR9le7PLuEKxg654wXt3KM2PZGVWbotIyBK0CvGzqGkppvwT23QdDDqSdkWuGQIhGQ0xBOdYkwebycxP5wwPUmObG+mymQ1Be2BXvmghttsiJdKlt4CVSYOJUMus6kU32G95hdTgKblsX4J1Of2i1nYsjyMKh3k945tqXwQrIsxOOQug0oIkz24zlLaOaQcorWtJ6Y1HPaZKpVIFUEF0y8Uq/O4oB2bOYC6WDUQfpj7nRG6xbi+BeBS84m1ttCEk4g="
+  matrix:
+  - BUILD=deploy
+  - BUILD=doc
+  - BUILD=sonar
+  - BUILD=coveralls
+
+matrix:
+  fast_finish: true
+
+before_install:
+  - wget https://github.com/sormuras/bach/raw/master/install-jdk.sh
+  - bash .travis/setup-secrets.sh
+  - bash .travis/configure-maven.sh
+# Install OracleJDK 10 - see https://sormuras.github.io/blog/2018-03-20-jdk-matrix.html
+install: . ./install-jdk.sh -F 10 -L BCL
+before_script: true
+script: source .travis/build-$BUILD.sh
+after_success: true
+
+
+before_deploy: true
+deploy:
+  provider: releases
+  api_key: ${GITHUB_OAUTH_TOKEN}
+  file_glob: true
+  file:
+  - pmd-dist/target/pmd-*.zip
+  - docs/pmd-doc-*.zip
+  skip_cleanup: true
+  on:
+    tags: true
+    repo: pmd/pmd
+    condition: "${TRAVIS_SECURE_ENV_VARS} = true && ${BUILD} != sonar"
+after_deploy: bash .travis/release.sh
+
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/0e6dd310db54b96c2653
+      - https://webhooks.gitter.im/e/65efc1ea65175ad23ab6
+    on_success: always  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: never     # options: [always|never|change] default: always
+  email:
+    recipients:
+    - andreas.dangel@adangel.org
+    on_success: change
+    on_failure: always
+cache:
+  directories:
+  - "$HOME/.m2"
+
+
+# Secure Keys, that need to be set for snapshot builds
+#
+# CI_DEPLOY_USERNAME - the user which can upload net.sourceforge.pmd:* to https://oss.sonatype.org/
+# CI_DEPLOY_PASSWORD
+#
+# SONAR_TOKEN - the token used to update https://sonarqube.com/dashboard/?id=393826
+#
+# PMD_SF_USER - the sourceforge user, which is used to upload created binaries to sf files section. Note: an ssh key is
+#               required. See "before_install".
+#
+#
+# Secure Keys, that need to be set for releases:
+#
+# PMD_SF_APIKEY - used to make the new release the default file in the files section. See https://sourceforge.net/auth/preferences/
+#               under "Release API Key"
+#
+# CI_SIGN_KEYNAME
+# CI_SIGN_PASSPHRASE
+# add the encrypted GPG keyring file to repo (https://docs.travis-ci.com/user/encrypting-files/#Automated-Encryption), decrypt it and install it at the beginning of .travis-deploy.sh
+#
+# GITHUB_OAUTH_TOKEN - the token used to upload the binaries to github releases
+#
+

.travis/build-coveralls.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+set -e
+
+source .travis/logger.sh
+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 | tail -1)
+log_info "Building PMD Coveralls.io report ${VERSION} on branch ${TRAVIS_BRANCH}"
+
+if ! travis_isPush; then
+    echo "Not proceeding, since this is not a push!"
+    exit 0
+fi
+
+#
+# for java9: enable all modules.
+# coveralls plugin seems to need java.xml.bind module
+echo "MAVEN_OPTS='-Xms1g -Xmx1g --add-modules java.se.ee'" > ${HOME}/.mavenrc
+
+(
+    # disable fast fail, exit immediately, in this subshell
+    set +e
+
+    ./mvnw clean install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
+    ./mvnw test jacoco:report coveralls:report -Pcoveralls -B -V
+
+    if [ $? -ne 0 ]; then
+        log_error "Error creating coveralls report"
+    else
+        log_success "New coveralls result: https://coveralls.io/github/pmd/pmd"
+    fi
+    true
+)

.travis/build-deploy.sh

@@ -0,0 +1,78 @@
+#!/bin/bash
+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
+            git commit -m "Update documentation"
+            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
+}
+
+
+VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
+log_info "Building PMD ${VERSION} on branch ${TRAVIS_BRANCH}"
+
+MVN_BUILD_FLAGS="-B -V"
+
+if travis_isPullRequest; then
+
+    log_info "This is a pull-request build"
+    ./mvnw verify $MVN_BUILD_FLAGS
+
+elif travis_isPush; then
+
+    if [[ "${VERSION}" != *-SNAPSHOT && "${TRAVIS_TAG}" != "" ]]; then
+        echo -e "\n\n"
+        log_info "This is a release build for tag ${TRAVIS_TAG}"
+        echo -e "\n\n"
+        ./mvnw deploy -Possrh,pmd-release $MVN_BUILD_FLAGS
+    elif [[ "${VERSION}" == *-SNAPSHOT ]]; then
+        log_info "This is a snapshot build"
+        ./mvnw deploy -Possrh $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..."
+        ./mvnw verify $MVN_BUILD_FLAGS
+        # we stop here - no need to execute further steps
+        exit 0
+    fi
+
+    (
+        # disable fast fail, exit immediately, in this subshell
+        set +e
+
+        echo -e "\n\n"
+        log_info "Uploading pmd distribution to sourceforge..."
+        rsync -avh pmd-dist/target/pmd-*-${VERSION}.zip ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/
+        if [ $? -ne 0 ]; then
+            log_error "Error while uploading pmd-*-${VERSION}.zip to sourceforge!"
+            log_error "Please upload manually: https://sourceforge.net/projects/pmd/files/pmd/"
+        fi
+        rsync -avh docs/pages/release_notes.md ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/ReadMe.md
+        if [ $? -ne 0 ]; then
+            log_error "Error while uploading release_notes.md as ReadMe.md to sourceforge!"
+            log_error "Please upload manually: https://sourceforge.net/projects/pmd/files/pmd/"
+        fi
+        true
+    )
+
+else
+    log_info "This is neither a pull request nor a push. Not executing any build."
+    exit 1
+fi

.travis/build-doc.sh

@@ -0,0 +1,82 @@
+#!/bin/bash
+set -e
+
+source .travis/logger.sh
+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 | tail -1)
+log_info "Building PMD Documentation ${VERSION} on branch ${TRAVIS_BRANCH}"
+
+if ! travis_isPush; then
+    log_info "Not building site, since this is not a push!"
+    exit 0
+fi
+
+pushd docs
+
+# run jekyll
+echo -e "\n\n"
+log_info "Building documentation using jekyll..."
+bundle install
+bundle exec jekyll build
+
+# create pmd-doc archive
+echo -e "\n\n"
+log_info "Creating pmd-doc archive..."
+mv _site pmd-doc-${VERSION}
+zip -qr pmd-doc-${VERSION}.zip pmd-doc-${VERSION}/
+
+(
+    # disable fast fail, exit immediately, in this subshell
+    set +e
+
+    if [[ "${TRAVIS_TAG}" != "" || "${VERSION}" == *-SNAPSHOT ]]; then
+        echo -e "\n\n"
+        log_info "Uploading pmd doc distribution to sourceforge..."
+        rsync -avh pmd-doc-${VERSION}.zip ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/
+        if [ $? -ne 0 ]; then
+            log_error "Couldn't upload pmd-doc-${VERSION}.zip!"
+            log_error "Please upload manually: https://sourceforge.net/projects/pmd/files/pmd/"
+        fi
+    fi
+
+    # rsync site to pmd.sourceforge.net/snapshot
+    if [[ "${VERSION}" == *-SNAPSHOT && "${TRAVIS_BRANCH}" == "master" ]] && has_docs_change; then
+        echo -e "\n\n"
+        log_info "Uploading snapshot site to pmd.sourceforge.net/snapshot..."
+        travis_wait rsync -ah --stats --delete pmd-doc-${VERSION}/ ${PMD_SF_USER}@web.sourceforge.net:/home/project-web/pmd/htdocs/snapshot/
+        if [ $? -ne 0 ]; then
+            log_error "Couldn't upload the snapshot documentation. It won't be current on http://pmd.sourceforge.net/snapshot/"
+        else
+            log_success "Successfully uploaded snapshot documentation: http://pmd.sourceforge.net/snapshot/"
+        fi
+    fi
+
+    true
+)
+
+
+
+#
+# Push the generated site to gh-pages branch
+#
+if [[ "${VERSION}" == *-SNAPSHOT && "${TRAVIS_BRANCH}" == "master" ]] && has_docs_change; then
+    echo -e "\n\n"
+    log_info "Pushing the new site to github pages..."
+    git clone --branch gh-pages --depth 1 git@github.com:pmd/pmd.git pmd-gh-pages
+    # clear the files first
+    rm -rf pmd-gh-pages/*
+    # copy the new site
+    cp -a pmd-doc-${VERSION}/* pmd-gh-pages/
+    (
+        cd pmd-gh-pages
+        git config user.name "Travis CI (pmd-bot)"
+        git config user.email "andreas.dangel+pmd-bot@adangel.org"
+        git add -A
+        git commit -q -m "Update documentation"
+        git push git@github.com:pmd/pmd.git HEAD:gh-pages
+        log_success "Successfully pushed site to https://pmd.github.io/pmd/"
+    )
+fi
+
+popd

.travis/build-sonar.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+set -e
+
+source .travis/logger.sh
+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 | tail -1)
+log_info "Building PMD Sonar ${VERSION} on branch ${TRAVIS_BRANCH}"
+
+if ! travis_isPush; then
+    echo "Not updating sonar, since this is not a push!"
+    exit 0
+fi
+
+#
+# for java9: enable all modules.
+# sonar plugin seems to need java.xml.bind module
+echo "MAVEN_OPTS='-Xms1g -Xmx1g --add-modules java.se.ee'" > ${HOME}/.mavenrc
+
+(
+    # disable fast fail, exit immediately, in this subshell
+    set +e
+
+    # Run the build
+    ./mvnw clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=${SONAR_TOKEN} -B -V
+
+    if [ $? -ne 0 ]; then
+        log_error "Error updating sonar..."
+    else
+        log_success "New sonar results: https://sonarcloud.io/dashboard?id=net.sourceforge.pmd%3Apmd"
+    fi
+    true
+)

.travis/common-functions.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+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}"
+
+function travis_isPullRequest() {
+    if [ "${TRAVIS_REPO_SLUG}" != "pmd/pmd" ] || [ "${TRAVIS_PULL_REQUEST}" != "false" ]; then
+        return 0
+    else
+        return 1
+    fi
+}
+
+function travis_isPush() {
+    if [ "${TRAVIS_REPO_SLUG}" = "pmd/pmd" ] && [ "${TRAVIS_PULL_REQUEST}" = "false" ] && [ "${TRAVIS_SECURE_ENV_VARS}" = "true" ]; 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"
+        return 0
+    else
+        log_info "Checking for changes in docs/ (TRAVIS_COMMIT_RANGE=${TRAVIS_COMMIT_RANGE}): no changes"
+        return 1
+    fi
+}

.travis/configure-maven.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e
+
+echo "MAVEN_OPTS='-Xms1g -Xmx1g'" > ${HOME}/.mavenrc
+mkdir -p ${HOME}/.m2
+cp .travis/travis-settings.xml ${HOME}/.m2/settings.xml

.travis/id_rsa.pub

@@ -0,0 +1 @@
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQC8yHVLHYDsKui8tYg/sFvkDqcs97pEZz0BzK9HtBF4O+/It1drRYRdUAFfjoImfprpKSxkJCTglHixGRp24eNaZ6woWVJ4/bmiMkEqEZAjr1NZ3qw7zIruMJMSkCV+YTtmL4cYcZlvMRPzzOZOnFbV05oi79oy41MUFHYjolK9QxMFNsVNN5iyzFxM3HqSFozz+ylKbFBtDk6ZHZQNRL/Xl2V9DJ69fVzjG4OZfcWNGmmKHHARmsnJyUOMeeKpLjDOe1M6ZdI8HkXWac8yCr9JTETNZZwemZAcS/RKoKCDqfIUOzkZfIPmyaznfVetTGsMi7yQrJhAyjznuNGF4+3lfgTcmRF8wz5FCeUkdYTmy2wNSFi5HiLPfC5OgRtjKzC6yb8rbRjDx6XQ2ph15PKOaXwzk49TaMc0xJvoiGDMZaTU0iTm3Y1/QUtfLvo3/jGMbtUdV3soWpuBAV2JUI4aB5xdLX9iNmcrVzoUe3y9DWuuTX46eoCvpUNXv/DXKhQw1D7xd7J67db5qUck/Akiqi0JR+e0SoBJvZFtYwVNLGC2bIJ/s8SR8X5Zp+1+ypf3WYjIylxQTkO1r4NfI0Cd9qXg7nmUrHAU7Z6xtJmUK8ZWzSST4wul8WkRJURtODLxt5firtlKhyZ93t9Mjuk6mATIPxr/b3x20T+IH463kw== ssh key for pmd. used for travis accessing sourceforge and github.

.travis/logger.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+COL_GREEN="\e[32m"
+COL_RED="\e[31m"
+COL_RESET="\e[0m"
+COL_YELLOW="\e[33;1m"
+
+function log_error() {
+    echo -e "${COL_RED}[ERROR] $*${COL_RESET}"
+}
+
+function log_info() {
+    echo -e "${COL_YELLOW}[INFO] $*${COL_RESET}"
+}
+
+function log_success() {
+    echo -e "${COL_GREEN}[SUCCESS] $*${COL_RESET}"
+}

.travis/release.sh

@@ -0,0 +1,117 @@
+#!/bin/bash
+set -e
+
+source .travis/logger.sh
+
+echo "BUILD: $BUILD"
+RELEASE_VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
+echo "RELEASE_VERSION: $RELEASE_VERSION"
+
+if [ "${BUILD}" = "deploy" ]; then
+
+# Deploy to ossrh has already been done with the usual build. See build-deploy.sh
+
+(
+    # disable fast fail, exit immediately, in this subshell
+    set +e
+
+    # The site has been built before, the files have already been uploaded to sourceforge.
+    # Since this is a release, making the binary the new default file...
+    log_info "Selecting pmd-bin-${RELEASE_VERSION} as default on sourceforge.net..."
+    curl -H "Accept: application/json" -X PUT -d "default=windows&default=mac&default=linux&default=bsd&default=solaris&default=others" \
+         -d "api_key=${PMD_SF_APIKEY}" https://sourceforge.net/projects/pmd/files/pmd/${RELEASE_VERSION}/pmd-bin-${RELEASE_VERSION}.zip
+    if [ $? -ne 0 ]; then
+        log_error "Couldn't select latest binary as default on sourceforge.net"
+    else
+        log_info "pmd-bin-${RELEASE_VERSION} is now the default download option."
+    fi
+    true
+)
+
+
+# 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=$(tail -n +6 docs/pages/release_notes.md) # skips the first 6 lines - the heading 'PMD 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
+    echo "Request:"
+    cat release-edit-request.json
+    echo
+    echo "Response:"
+    echo "$RESPONSE"
+else
+    echo "Update OK"
+fi
+
+fi
+
+
+if [ "${BUILD}" = "doc" ]; then
+
+echo -e "\n\n"
+log_info "Adding the new doc to pmd.github.io..."
+# clone pmd.github.io. Note: This uses the ssh key setup earlier
+# In order to speed things up, we use a sparse checkout - no need to checkout all directories here
+mkdir pmd.github.io
+(
+    cd pmd.github.io
+    git init
+    git config user.name "Travis CI (pmd-bot)"
+    git config user.email "andreas.dangel+pmd-bot@adangel.org"
+    git config core.sparsecheckout true
+    git remote add origin git@github.com:pmd/pmd.github.io.git
+    echo "latest/" > .git/info/sparse-checkout
+    git pull --depth=1 origin master
+    rsync -a ../docs/pmd-doc-${RELEASE_VERSION}/ pmd-${RELEASE_VERSION}/
+    git add pmd-${RELEASE_VERSION}
+    git commit -q -m "Added pmd-${RELEASE_VERSION}"
+
+    git rm -qr latest
+    cp -a pmd-${RELEASE_VERSION} latest
+    git add latest
+    git commit -q -m "Copying pmd-${RELEASE_VERSION} to latest"
+
+    ../.travis/sitemap_generator.sh > sitemap.xml
+    git add sitemap.xml
+    git commit -q -m "Generated sitemap.xml"
+    git push origin master
+)
+
+
+
+(
+    echo -e "\n\n"
+
+    # disable fast fail, exit immediately, in this subshell
+    set +e
+
+    log_info "Uploading the new release to pmd.sourceforge.net which serves as an archive..."
+
+    travis_wait rsync -ah --stats pmd-doc-${VERSION}/ ${PMD_SF_USER}@web.sourceforge.net:/home/project-web/pmd/htdocs/pmd-${RELEASE_VERSION}/
+
+    if [ $? -ne 0 ]; then
+        log_error "Uploading documentation to pmd.sourceforge.net failed..."
+        log_error "Please upload manually (PMD Version: ${RELEASE_VERSION})"
+    else
+        log_success "The documentation is now available under http://pmd.sourceforge.net/pmd-${RELEASE_VERSION}/"
+    fi
+    true
+)
+
+
+fi
+

.travis/setup-secrets.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+set -e
+
+if [ "${TRAVIS_REPO_SLUG}" != "pmd/pmd" ] || [ "${TRAVIS_PULL_REQUEST}" != "false" ] || [ "${TRAVIS_SECURE_ENV_VARS}" != "true" ] || [ "${encrypted_5630fbebf057_iv}" = "" ]; then
+    echo "Not setting up secrets:"
+    echo "  TRAVIS_REPO_SLUG=${TRAVIS_REPO_SLUG}"
+    echo "  TRAVIS_PULL_REQUEST=${TRAVIS_PULL_REQUEST}"
+    echo "  TRAVIS_SECURE_ENV_VARS=${TRAVIS_SECURE_ENV_VARS}"
+    [ "${encrypted_5630fbebf057_iv}" = "" ] && echo "  Variable encrypted_5630fbebf057_iv is not set"
+    exit 0
+fi
+
+echo "Setting up secrets..."
+
+openssl aes-256-cbc -K ${encrypted_5630fbebf057_key} -iv ${encrypted_5630fbebf057_iv} -in .travis/secrets.tar.enc -out .travis/secrets.tar -d
+pushd .travis && tar xfv secrets.tar && popd
+mkdir -p "$HOME/.ssh"
+chmod 700 "$HOME/.ssh"
+mv .travis/id_rsa "$HOME/.ssh/id_rsa"
+chmod 600 "$HOME/.ssh/id_rsa"
+mkdir -p "$HOME/.gpg"
+gpg --batch --import .travis/release-signing-key-82DE7BE82166E84E.gpg
+rm .travis/secrets.tar
+rm .travis/release-signing-key-82DE7BE82166E84E.gpg

.travis/sitemap_generator.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+# Sitemap generator
+# Assumes we have the latest version of the site under "latest" and "pmd-${RELEASE_VERSION}"
+# https://www.sitemaps.org/protocol.html
+
+WEBSITE_PREFIX="https://pmd.github.io/"
+DOC_PREFIX="latest/" # "pmd-${RELEASE_VERSION}/"
+DATE=`date +%Y-%m-%d`
+# Priority is relative to the website, can be chosen in {0.1, 0.2, ..., 1}
+# Default priority is 0.5
+LATEST_PRIORITY=0.8
+
+
+# Writes to standard output
+
+cat << HEADER_END
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+
+    <url>
+        <loc>${WEBSITE_PREFIX}index.html</loc>
+        <priority>1</priority>
+        <changefreq>monthly</changefreq>
+        <lastmod>$DATE</lastmod>
+    </url>
+
+    <url>
+        <loc>${WEBSITE_PREFIX}${DOC_PREFIX}index.html</loc>
+        <priority>0.9</priority>
+        <changefreq>monthly</changefreq>
+        <lastmod>$DATE</lastmod>
+    </url>
+
+
+
+HEADER_END
+
+
+for page in ${DOC_PREFIX}pmd_*.html
+do
+
+    cat << ENTRY_END
+    <url>
+        <loc>${WEBSITE_PREFIX}$page</loc>
+        <priority>$LATEST_PRIORITY</priority>
+        <changefreq>monthly</changefreq>
+        <lastmod>$DATE</lastmod>
+    </url>
+
+ENTRY_END
+
+done
+
+echo "</urlset>"
+

.travis/travis-settings.xml

@@ -0,0 +1,29 @@
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
+                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
+  <localRepository/>
+  <interactiveMode/>
+  <usePluginRegistry/>
+  <offline/>
+  <pluginGroups/>
+  <servers>
+    <server>
+      <id>ossrh</id>
+      <username>${env.CI_DEPLOY_USERNAME}</username>
+      <password>${env.CI_DEPLOY_PASSWORD}</password>
+    </server>
+  </servers>
+  <mirrors/>
+  <proxies/>
+  <profiles>
+    <profile>
+      <id>ossrh</id>
+      <properties>
+        <gpg.keyname>${env.CI_SIGN_KEYNAME}</gpg.keyname>
+        <gpg.passphrase>${env.CI_SIGN_PASSPHRASE}</gpg.passphrase>
+      </properties>
+    </profile>
+  </profiles>
+  <activeProfiles/>
+</settings>

BUILDING.md

@@ -0,0 +1,28 @@
+# How to build PMD
+
+PMD uses [Maven](https://maven.apache.org/) and requires [Java 9](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+for building.
+
+PMD uses the [maven wrapper](https://github.com/takari/maven-wrapper), so you can simply build PMD as following:
+
+*   `./mvnw clean verify` (on Unix-like platform such as Linux and Mac OS X)
+*   `mvnw.cmd clean verify` (on Windows)
+
+This will create the zip files in the directory `pmd-dist/target`:
+
+    cd pmd-dist/target
+    ls *.zip
+
+That's all !
+
+**Note:** While Java 9 is required for building, running PMD only requires Java 7 (or Java 8 for Apex).
+
+## How to build the documentation?
+
+    cd docs
+    bundle install # once
+    bundle exec jekyll build
+
+You'll find the built site in the directory `_site/`.
+
+For more info, see [README in docs directory](docs/README.md).

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# How to contribute to PMD
+
+First off, thanks for taking the time to contribute!
+
+
+## Pull requests
+
+*   Please create your pull request against the `master` branch. We will rebase/merge it to the maintenance
+    branches, if necessary.
+
+*   We are using [checkstyle](http://checkstyle.sourceforge.net/) to enforce a common code style.
+    The check is integrated into the default build - so, make sure, you can [build PMD](BUILDING.md) without errors.
+    See [code style](#code-style) for more info.
+
+
+## Bug reports
+
+We used to use Sourceforge for bug tracking, but we are in the process of moving to github issues.
+
+*   Old bugs are still available at <https://sourceforge.net/p/pmd/bugs/>.
+*   Please report new bugs at <https://github.com/pmd/pmd/issues>.
+
+When filing a bug report, please provide as much information as possible, so that we can reproduce the issue:
+
+*   The name of the rule, that is buggy
+*   A code snippet, which triggers a false positive/negative or crash
+*   How do you execute PMD? (command line, ant, maven, gradle, other)
+
+
+## Documentation
+
+There is some documentation available under <https://pmd.github.io/pmd>. Feel free to create a bug report if
+documentation is missing, incomplete or outdated. See [Bug reports](#bug-reports).
+
+The documentation is generated as a Jekyll site, the source is available at: <https://github.com/pmd/pmd/tree/master/docs>. You can find build instructions there.
+For more on contributing documentation check <https://pmd.github.io/pmd/pmd_devdocs_writing_documentation.html>
+
+## Questions
+
+There are various channels, on which you can ask questions:
+
+*   The mailing list: [pmd-devel](https://lists.sourceforge.net/lists/listinfo/pmd-devel)
+
+*   The discussion forums on sourceforge: <https://sourceforge.net/p/pmd/discussion/>
+
+*   On [StackOverflow](https://stackoverflow.com/questions/tagged/pmd): Make sure, to tag your question with "pmd".
+
+## Code Style
+
+PMD uses [checkstyle](http://checkstyle.sourceforge.net/) to enforce a common code style.
+
+See [pmd-checkstyle-config.xml](https://github.com/pmd/build-tools/blob/master/config/src/main/resources/net/sourceforge/pmd/pmd-checkstyle-config.xml) for the configuration and
+[the eclipse configuration files](https://github.com/pmd/build-tools/tree/master/config/eclipse) that can
+be imported into a fresh workspace.
+
+

README.md

@@ -1,27 +1,27 @@
-[![PMD - Don't shoot the messenger][PMDLogo]][website]
+# PMD
 
-PMD
-===
+[![Join the chat at https://gitter.im/pmd/pmd](https://badges.gitter.im/pmd/pmd.svg)](https://gitter.im/pmd/pmd?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build Status](https://travis-ci.org/pmd/pmd.svg?branch=master)](https://travis-ci.org/pmd/pmd)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd)
+[![Coverage Status](https://coveralls.io/repos/github/pmd/pmd/badge.svg)](https://coveralls.io/github/pmd/pmd)
 
-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, XML, XSL.
-Additionally it includes CPD, the copy-paste-detector. CPD finds duplicated code in
-Java, C, C++, C#, PHP, Ruby, Fortran, JavaScript.
+## About
 
-Source
-------
-Our latest source of PMD can be found on [GitHub]. Fork us!
-The current status of this repo can be seen at [BuildHive].
+**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.
 
-News and Website
-----------------
-More information can be found on our [Website] and on [SourceForge].
+Additionally it includes **CPD**, the copy-paste-detector. CPD finds duplicated code in
+Java, C, C++, C#, Groovy, PHP, Ruby, Fortran, JavaScript, PLSQL, Apache Velocity, Scala, Objective C,
+Salesforce.com Apex, Perl, Swift, Matlab, Python.
 
+## Source and Documentation
 
-[PMDLogo]: http://pmd.sourceforge.net/pmd_logo.png
-[GitHub]: https://github.com/pmd/pmd
-[BuildHive]: https://buildhive.cloudbees.com/job/pmd/
-[Website]: http://pmd.sourceforge.net
-[SourceForge]: https://sourceforge.net/projects/pmd/
+Our latest source of PMD can be found on [GitHub](https://github.com/pmd/pmd). Fork us!
+
+*   [How to build PMD](BUILDING.md)
+*   [How to contribute to PMD](CONTRIBUTING.md)
+
+## News and Website
+
+More information can be found on our [Website](https://pmd.github.io) and on [SourceForge](https://sourceforge.net/projects/pmd/).

do-release.sh

@@ -0,0 +1,206 @@
+#!/bin/bash
+
+# Make sure, everything is English...
+export LANG=C.UTF8
+
+# verify the current directory
+if [ ! -f pom.xml -o ! -d ../pmd.github.io ]; then
+    echo "You seem to be in the wrong working directory or you don't have pmd.github.io checked out..."
+    echo
+    echo "Expected:"
+    echo "*   You are currently in the pmd repository"
+    echo "*   ../pmd.github.io is the pmd.github.io repository"
+    echo
+    exit 1
+fi
+
+
+RELEASE_VERSION=
+DEVELOPMENT_VERSION=
+CURRENT_BRANCH=
+
+echo "-------------------------------------------"
+echo "Releasing PMD"
+echo "-------------------------------------------"
+
+# see also https://gist.github.com/pdunnavant/4743895
+CURRENT_VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec)
+RELEASE_VERSION=${CURRENT_VERSION%-SNAPSHOT}
+MAJOR=$(echo $RELEASE_VERSION | cut -d . -f 1)
+MINOR=$(echo $RELEASE_VERSION | cut -d . -f 2)
+PATCH=$(echo $RELEASE_VERSION | cut -d . -f 3)
+if [ "$PATCH" == "0" ]; then
+    NEXT_MINOR=$(expr ${MINOR} + 1)
+    NEXT_PATCH="0"
+else
+    # this is a bugfixing release
+    NEXT_MINOR="${MINOR}"
+    NEXT_PATCH=$(expr ${PATCH} + 1)
+fi
+DEVELOPMENT_VERSION="$MAJOR.$NEXT_MINOR.$NEXT_PATCH"
+DEVELOPMENT_VERSION="${DEVELOPMENT_VERSION}-SNAPSHOT"
+
+# allow to override the next version, e.g. via "NEXT_VERSION=7.0.0 ./do-release.sh"
+if [ "$NEXT_VERSION" != "" ]; then
+    DEVELOPMENT_VERSION="${NEXT_VERSION}-SNAPSHOT"
+fi
+
+
+# http://stackoverflow.com/questions/1593051/how-to-programmatically-determine-the-current-checked-out-git-branch
+CURRENT_BRANCH=$(git symbolic-ref -q HEAD)
+CURRENT_BRANCH=${CURRENT_BRANCH##refs/heads/}
+CURRENT_BRANCH=${CURRENT_BRANCH:-HEAD}
+
+echo "RELEASE_VERSION: ${RELEASE_VERSION}"
+echo "DEVELOPMENT_VERSION: ${DEVELOPMENT_VERSION}"
+echo "CURRENT_BRANCH: ${CURRENT_BRANCH}"
+
+echo
+echo "Is this correct?"
+echo
+echo "Press enter to continue..."
+read
+
+
+export RELEASE_VERSION
+export DEVELOPMENT_VERSION
+export CURRENT_BRANCH
+
+RELEASE_RULESET="pmd-core/src/main/resources/rulesets/releases/${RELEASE_VERSION//\./}.xml"
+
+echo "*   Update version/release info in **docs/pages/release_notes.md**."
+echo
+echo "    ## $(date -u +%d-%B-%Y) - ${RELEASE_VERSION}"
+echo
+echo "*   Update date info in **docs/_config.yml**."
+echo
+echo "*   Ensure all the new rules are listed in a the proper file:"
+echo "    ${RELEASE_RULESET}"
+echo
+echo "*   Update **../pmd.github.io/_config.yml** to mention the new release"
+echo
+echo "*   Add **../pmd.github.io/_posts/$(date -u +%Y-%m-%d)-PMD-${RELEASE_VERSION}.md"
+echo
+echo "Press enter to continue..."
+read
+echo "Committing current changes (pmd)"
+
+if [[ -e ${RELEASE_RULESET} ]]
+then
+    git add ${RELEASE_RULESET}
+fi
+
+git commit -a -m "Prepare pmd release ${RELEASE_VERSION}"
+(
+    echo "Committing current changes (pmd.github.io)"
+    cd ../pmd.github.io
+    git add _posts/$(date -u +%Y-%m-%d)-PMD-${RELEASE_VERSION}.md
+    git commit -a -m "Prepare pmd release ${RELEASE_VERSION}"
+    git push
+)
+
+./mvnw -B release:clean release:prepare \
+    -Dtag=pmd_releases/${RELEASE_VERSION} \
+    -DreleaseVersion=${RELEASE_VERSION} \
+    -DdevelopmentVersion=${DEVELOPMENT_VERSION}
+
+
+echo
+echo "Tag has been pushed.... now check travis build: <https://travis-ci.org/pmd/pmd>"
+echo
+echo
+echo "Submit news to SF on <https://sourceforge.net/p/pmd/news/> page. You can use"
+echo "the following template:"
+echo
+cat <<EOF
+PMD ${RELEASE_VERSION} released
+
+* Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F${RELEASE_VERSION}
+* Documentation: https://pmd.github.io/pmd-${RELEASE_VERSION}/
+
+And Copy-Paste the release notes
+EOF
+echo
+echo "Press enter to continue..."
+read
+
+echo
+echo "Check the milestone on github:"
+echo "<https://github.com/pmd/pmd/milestones>"
+echo " --> move any open issues to the next milestone, close the current milestone"
+echo " --> Maybe there are some milestones on sourceforge, too: <https://sourceforge.net/p/pmd/bugs/milestones>."
+echo
+echo
+echo "Prepare Next development version:"
+echo "*   Update version/date info in **docs/_config.yml**."
+echo
+echo
+echo "Press enter to continue..."
+read
+
+# update release_notes_old
+OLD_RELEASE_NOTES=$(tail -n +8 docs/pages/release_notes_old.md)
+NEW_RELEASE_NOTES=$(tail -n +6 docs/pages/release_notes.md)
+echo "$(head -n 7 docs/pages/release_notes_old.md)" > docs/pages/release_notes_old.md
+echo "$NEW_RELEASE_NOTES" >> docs/pages/release_notes_old.md
+echo >> docs/pages/release_notes_old.md
+echo "$OLD_RELEASE_NOTES" >> docs/pages/release_notes_old.md
+
+# reset release notes template
+cat > docs/pages/release_notes.md <<EOF
+---
+title: PMD Release Notes
+permalink: pmd_release_notes.html
+keywords: changelog, release notes
+---
+
+## ????? - ${DEVELOPMENT_VERSION}
+
+The PMD team is pleased to announce PMD ${DEVELOPMENT_VERSION%-SNAPSHOT}.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+### Fixed Issues
+
+### API Changes
+
+### External Contributions
+
+EOF
+
+git commit -a -m "Prepare next development version"
+git push origin ${CURRENT_BRANCH}
+./mvwn -B release:clean
+echo
+echo
+echo
+echo "Verify the new release on github: <https://github.com/pmd/pmd/releases/tag/pmd_releases/${RELEASE_VERSION}>"
+echo
+echo
+echo "Send out an announcement mail to the mailing list:"
+echo "To: PMD Developers List <pmd-devel@lists.sourceforge.net>"
+echo "Subject: [ANNOUNCE] PMD ${RELEASE_VERSION} Released"
+echo
+echo "    *   Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F${RELEASE_VERSION}"
+echo "    *   Documentation: https://pmd.github.io/pmd-${RELEASE_VERSION}/"
+echo
+echo "    And Copy-Paste the release notes"
+echo
+echo
+echo
+echo "------------------------------------------"
+echo "Done."
+echo "------------------------------------------"
+echo
+
+
+

docs/.gitignore

@@ -0,0 +1,5 @@
+_site/
+.sass-cache/
+.jekyll-metadata
+_pdf
+.idea/

docs/404.md

@@ -0,0 +1,8 @@
+---
+title: "Page Not Found"
+search: exclude
+---  
+
+Sorry, but the page you were trying to view does not exist. Check the URL for correctness, or try using keyword search using our search bar.
+
+[Back to the index](index.html)

docs/Dockerfile

@@ -0,0 +1,26 @@
+FROM ruby:2.4.2
+MAINTAINER mrafayaleem@gmail.com
+
+RUN apt-get clean \
+  && mv /var/lib/apt/lists /var/lib/apt/lists.broke \
+  && mkdir -p /var/lib/apt/lists/partial
+
+RUN apt-get update
+
+RUN apt-get install -y \
+    node \
+    python-pygments \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/
+
+WORKDIR /tmp
+ADD Gemfile /tmp/
+ADD Gemfile.lock /tmp/
+RUN bundle install
+
+VOLUME /src
+EXPOSE 4000
+
+WORKDIR /src
+ENTRYPOINT ["jekyll"]
+

docs/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'jekyll'
+gem 'github-pages'

docs/Gemfile.lock

@@ -0,0 +1,250 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.10)
+      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)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.11.1)
+    colorator (1.1.0)
+    commonmarker (0.17.9)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (1.0.5)
+    dnsruby (1.60.2)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    eventmachine (1.2.7)
+    execjs (2.7.0)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.23)
+    forwardable-extended (2.6.0)
+    gemoji (3.0.0)
+    github-pages (186)
+      activesupport (= 4.2.10)
+      github-pages-health-check (= 1.8.1)
+      jekyll (= 3.7.3)
+      jekyll-avatar (= 0.5.0)
+      jekyll-coffeescript (= 1.1.1)
+      jekyll-commonmark-ghpages (= 0.1.5)
+      jekyll-default-layout (= 0.1.4)
+      jekyll-feed (= 0.9.3)
+      jekyll-gist (= 1.5.0)
+      jekyll-github-metadata (= 2.9.4)
+      jekyll-mentions (= 1.3.0)
+      jekyll-optional-front-matter (= 0.3.0)
+      jekyll-paginate (= 1.1.0)
+      jekyll-readme-index (= 0.2.0)
+      jekyll-redirect-from (= 0.13.0)
+      jekyll-relative-links (= 0.5.3)
+      jekyll-remote-theme (= 0.3.1)
+      jekyll-sass-converter (= 1.5.2)
+      jekyll-seo-tag (= 2.4.0)
+      jekyll-sitemap (= 1.2.0)
+      jekyll-swiss (= 0.4.0)
+      jekyll-theme-architect (= 0.1.1)
+      jekyll-theme-cayman (= 0.1.1)
+      jekyll-theme-dinky (= 0.1.1)
+      jekyll-theme-hacker (= 0.1.1)
+      jekyll-theme-leap-day (= 0.1.1)
+      jekyll-theme-merlot (= 0.1.1)
+      jekyll-theme-midnight (= 0.1.1)
+      jekyll-theme-minimal (= 0.1.1)
+      jekyll-theme-modernist (= 0.1.1)
+      jekyll-theme-primer (= 0.5.3)
+      jekyll-theme-slate (= 0.1.1)
+      jekyll-theme-tactile (= 0.1.1)
+      jekyll-theme-time-machine (= 0.1.1)
+      jekyll-titles-from-headings (= 0.5.1)
+      jemoji (= 0.9.0)
+      kramdown (= 1.16.2)
+      liquid (= 4.0.0)
+      listen (= 3.1.5)
+      mercenary (~> 0.3)
+      minima (= 2.4.1)
+      nokogiri (>= 1.8.2, < 2.0)
+      rouge (= 2.2.1)
+      terminal-table (~> 1.4)
+    github-pages-health-check (1.8.1)
+      addressable (~> 2.3)
+      dnsruby (~> 1.60)
+      octokit (~> 4.0)
+      public_suffix (~> 2.0)
+      typhoeus (~> 1.3)
+    html-pipeline (2.8.0)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.7.3)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-avatar (0.5.0)
+      jekyll (~> 3.0)
+    jekyll-coffeescript (1.1.1)
+      coffee-script (~> 2.2)
+      coffee-script-source (~> 1.11.1)
+    jekyll-commonmark (1.2.0)
+      commonmarker (~> 0.14)
+      jekyll (>= 3.0, < 4.0)
+    jekyll-commonmark-ghpages (0.1.5)
+      commonmarker (~> 0.17.6)
+      jekyll-commonmark (~> 1)
+      rouge (~> 2)
+    jekyll-default-layout (0.1.4)
+      jekyll (~> 3.0)
+    jekyll-feed (0.9.3)
+      jekyll (~> 3.3)
+    jekyll-gist (1.5.0)
+      octokit (~> 4.2)
+    jekyll-github-metadata (2.9.4)
+      jekyll (~> 3.1)
+      octokit (~> 4.0, != 4.4.0)
+    jekyll-mentions (1.3.0)
+      activesupport (~> 4.0)
+      html-pipeline (~> 2.3)
+      jekyll (~> 3.0)
+    jekyll-optional-front-matter (0.3.0)
+      jekyll (~> 3.0)
+    jekyll-paginate (1.1.0)
+    jekyll-readme-index (0.2.0)
+      jekyll (~> 3.0)
+    jekyll-redirect-from (0.13.0)
+      jekyll (~> 3.3)
+    jekyll-relative-links (0.5.3)
+      jekyll (~> 3.3)
+    jekyll-remote-theme (0.3.1)
+      jekyll (~> 3.5)
+      rubyzip (>= 1.2.1, < 3.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.4.0)
+      jekyll (~> 3.3)
+    jekyll-sitemap (1.2.0)
+      jekyll (~> 3.3)
+    jekyll-swiss (0.4.0)
+    jekyll-theme-architect (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-cayman (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-dinky (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-hacker (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-leap-day (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-merlot (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-midnight (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-minimal (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-modernist (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-primer (0.5.3)
+      jekyll (~> 3.5)
+      jekyll-github-metadata (~> 2.9)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-slate (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-tactile (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-time-machine (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-titles-from-headings (0.5.1)
+      jekyll (~> 3.3)
+    jekyll-watch (2.0.0)
+      listen (~> 3.0)
+    jemoji (0.9.0)
+      activesupport (~> 4.0, >= 4.2.9)
+      gemoji (~> 3.0)
+      html-pipeline (~> 2.2)
+      jekyll (~> 3.0)
+    kramdown (1.16.2)
+    liquid (4.0.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (0.3.6)
+    mini_portile2 (2.3.0)
+    minima (2.4.1)
+      jekyll (~> 3.5)
+      jekyll-feed (~> 0.9)
+      jekyll-seo-tag (~> 2.1)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    octokit (4.9.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pathutil (0.16.1)
+      forwardable-extended (~> 2.6)
+    public_suffix (2.0.5)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (2.2.1)
+    ruby-enum (0.7.2)
+      i18n
+    ruby_dep (1.5.0)
+    rubyzip (1.2.1)
+    safe_yaml (1.0.4)
+    sass (3.5.6)
+      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)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-pages
+  jekyll
+
+BUNDLED WITH
+   1.16.2

docs/README.md

@@ -0,0 +1,22 @@
+# PMD-New-Site
+New Site For PMD Core Open Source Project
+
+## Site Theme
+
+This site was built using the tomjohnson1492/documentation-theme-jekyll theme
+
+A Jekyll-based theme designed for documentation and help systems. See the link for detailed instructions on setting up and configuring everything. http://idratherbewriting.com/documentation-theme-jekyll/
+
+## Building using Bundler
+
+    bundle install # once
+    bundle exec jekyll serve
+
+Go to: http://localhost:4005/
+
+## Building using Docker
+
+    docker build --no-cache -t pmd-doc . # once
+    docker run --rm=true -v "$PWD:/src" -p 4005:4005 pmd-doc serve -H 0.0.0.0
+
+Go to: http://localhost:4005/