Merge remote-tracking branch 'origin/master' into apex-update

.travis.yml

@@ -1,5 +1,5 @@
+dist: trusty
 sudo: false
-
 addons:
   apt:
     packages:
@@ -23,15 +23,19 @@ env:
   - secure: "JIhuqaI0i+zvuqqXiQBHpuKr7AQ8jfk6Gbr8Qgiq4yJtdEWXZGxnAT9BmlbjkgT7ABXvLgxf2CIdUOMo1yYfBlxQL/y5+e89jaVpYF3tvNAzYQ1e12VzQRsd/jDb7qvm7tw3rDHEn3dSEot7Q6KbPcL6WzWJINVMCCmOgvq9gKHgE6Y5q5EgZ5rxiXyuO27ndzcbxaor4PIaiSzHO9+AJQ7p2zDLP+kG4nKVTBX0l9VoKiYFhIpIhpbigi3jyLDMDRiWpwTWZC6P8/RXfZg/lc5ADOuM2DM8oXPpZuqOa/g31LWQOSCuEnQ1G16vbLgipSPpgAc7jYWD5cywhG9dLkiKaZDh5x0meLM2RoAgz6eAnQfTTqJ68OM9o9yXjubEedsNpNRAr9/DXMd+fbh10W2vbvL5HCNB3lic3anehhR9le7PLuEKxg654wXt3KM2PZGVWbotIyBK0CvGzqGkppvwT23QdDDqSdkWuGQIhGQ0xBOdYkwebycxP5wwPUmObG+mymQ1Be2BXvmghttsiJdKlt4CVSYOJUMus6kU32G95hdTgKblsX4J1Of2i1nYsjyMKh3k945tqXwQrIsxOOQug0oIkz24zlLaOaQcorWtJ6Y1HPaZKpVIFUEF0y8Uq/O4oB2bOYC6WDUQfpj7nRG6xbi+BeBS84m1ttCEk4g="
   matrix:
   - BUILD=deploy
-  - BUILD=site
+  - BUILD=doc
   - BUILD=sonar
+  - BUILD=coveralls
+
+matrix:
+  fast_finish: true
 
 before_install:
   - bash .travis/setup-secrets.sh
   - bash .travis/configure-maven.sh
 install: true
 before_script: true
-script: bash .travis/build-$BUILD.sh
+script: source .travis/build-$BUILD.sh
 after_success: true
 
 

.travis/build-coveralls.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -e
+
+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)
+echo "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
+
+
+travis_wait ./mvnw -q clean test jacoco:report coveralls:report -Pcoveralls
+

.travis/build-doc.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+set -e
+
+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)
+echo "Building PMD Documentation ${VERSION} on branch ${TRAVIS_BRANCH}"
+
+if ! travis_isPush; then
+    echo "Not building site, since this is not a push!"
+    exit 0
+fi
+
+pushd docs
+
+# run jekyll
+echo -e "\n\nBuilding documentation using jekyll...\n\n"
+bundle install
+bundle exec jekyll build
+
+# create pmd-doc archive
+echo -e "\n\nCreating pmd-doc archive...\n\n"
+mv _site pmd-doc-${VERSION}
+zip -qr pmd-doc-${VERSION}.zip pmd-doc-${VERSION}/
+
+
+# Uploading pmd doc distribution to sourceforge
+if [[ "$TRAVIS_TAG" != "" || "$VERSION" == *-SNAPSHOT ]]; then
+    echo -e "\n\nUploading pmd-doc archive to sourceforge...\n\n"
+    rsync -avh pmd-doc-${VERSION}.zip ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/
+fi
+
+# rsync site to pmd.sourceforge.net/snapshot
+if [[ "$VERSION" == *-SNAPSHOT && "$TRAVIS_BRANCH" == "master" ]]; then
+    echo -e "\n\nUploading snapshot site...\n\n"
+    travis_wait rsync -ah --stats --delete pmd-doc-${VERSION}/ ${PMD_SF_USER}@web.sourceforge.net:/home/project-web/pmd/htdocs/snapshot/
+fi
+
+popd

.travis/build-site.sh

@@ -13,24 +13,18 @@ fi
 
 
 (
-    export PING_SLEEP=30s
-    export BUILD_OUTPUT=/tmp/build-site.out
-    export PING_PID_FILE=/tmp/build-site-ping.pid
+    # Run the build, truncate output due to Travis log limits
 
-    source .travis/background-job-funcs.sh
+    echo -e "\n\nExecuting ./mvnw install..."
+    travis_wait ./mvnw install -DskipTests=true -B -V -q
+    echo "Finished executing ./mvnw install"
 
-    # Run the build, redirect output into the file
-    ./mvnw install -DskipTests=true -B -V >> $BUILD_OUTPUT 2>&1
-    ./mvnw site site:stage -Psite -B -V >> $BUILD_OUTPUT 2>&1
-
-    # The build finished without returning an error so dump a tail of the output
-    dump_output
-
-    # nicely terminate the ping output loop
-    kill_ping
+    echo -e "\n\nExecuting ./mvnw site site:stage...
+    travis_wait 40 ./mvnw site site:stage -DskipTests=true -Psite -B -V -q
+    echo "Finished executing ./mvnw site site:stage..."
 )
 
-# create pmd-doc archive
+echo -e "\n\nCreating pmd-doc archive...\n\n"
 (
     cd target
     mv staging pmd-doc-${VERSION}
@@ -44,20 +38,7 @@ fi
 
 (
     if [[ "$VERSION" == *-SNAPSHOT && "$TRAVIS_BRANCH" == "master" ]]; then
-        # this can take very long and no output is generated. therefore use the background job again
-        export PING_SLEEP=30s
-        export BUILD_OUTPUT=/tmp/build-site-upload.out
-        export PING_PID_FILE=/tmp/build-site-upload-ping.pid
-
-        source .travis/background-job-funcs.sh
-
-        # Uploading snapshot site...
-        rsync -ah --stats --delete target/pmd-doc-${VERSION}/ ${PMD_SF_USER}@web.sourceforge.net:/home/project-web/pmd/htdocs/snapshot/
-
-        # The build finished without returning an error so dump a tail of the output
-        dump_output
-
-        # nicely terminate the ping output loop
-        kill_ping
+        echo -e "\n\nUploading snapshot site...\n\n"
+        travis_wait rsync -ah --stats --delete target/pmd-doc-${VERSION}/ ${PMD_SF_USER}@web.sourceforge.net:/home/project-web/pmd/htdocs/snapshot/
     fi
 )

.travis/build-sonar.sh

@@ -12,18 +12,6 @@ if ! travis_isPush; then
 fi
 
 
-export PING_SLEEP=30s
-export BUILD_OUTPUT=/tmp/build-sonar.out
-export PING_PID_FILE=/tmp/build-sonar-ping.pid
-
-source .travis/background-job-funcs.sh
-
-# Run the build, redirect output into the file
-./mvnw clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.host.url=https://sonarqube.com -Dsonar.login=${SONAR_TOKEN} -B -V >> $BUILD_OUTPUT 2>&1
-
-# The build finished without returning an error so dump a tail of the output
-dump_output
-
-# nicely terminate the ping output loop
-kill_ping
+# Run the build, truncate output due to Travis log limits
+travis_wait ./mvnw clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.host.url=https://sonarqube.com -Dsonar.login=${SONAR_TOKEN} -B -V -q
 

README.md

@@ -2,6 +2,7 @@
 
 [![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
 

docs/.gitignore

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

docs/404.md

@@ -0,0 +1,6 @@
+---
+title: "Page Not Found"
+search: exclude
+---  
+
+Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct.

docs/Dockerfile

@@ -0,0 +1,26 @@
+FROM ruby:2.1
+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 'github-pages', group: :jekyll_plugins
+gem 'wdm', '>= 0.1.0' if Gem.win_platform?