Merge pull request #329 from openpreserve/integration

REL - Release 1.20

.gitattributes

@@ -1,2 +1,9 @@
 # Prevent interpretation as text and end-of-line conversions.
 *.warc binary
+*.pdf binary
+*.gif binary
+*.jpg binary
+*.jp2 binary
+*.jpx binary
+*.tif binary
+*.wav binary

.gitignore

@@ -1,12 +1,3 @@
-# Ignore Eclipse files
-.project
-.classpath
-.settings
-
-# Ignore IntelliJ files
-.idea
-**/*.iml
-
 # Ignore Maven artefacts
 target/
 pom.xml.tag
@@ -19,4 +10,9 @@ release.properties
 Gemfile.lock
 
 # Ignore Test Root
-test-root
+/test-root/
+
+# Ignore Eclipse artefacts
+**/.settings
+**/.project
+**/.classpath

.travis.yml

@@ -1,41 +1,52 @@
-language: java
+dist: trusty
+sudo: required
 
+language: java
 jdk:
-- oraclejdk7
-- oraclejdk8
+  - openjdk7
+  - openjdk8
+  - oraclejdk8
 
 branches:
   except:
-  - "/^v|d\\d+\\.\\d+\\.\\d+$/"
-  - "/^jenkins-jhove-v|d\\d+\\.\\d+\\.\\d+$/"
+    - "/^v|d\\d+\\.\\d+\\.\\d+$/"
+    - "/^jenkins-jhove-v|d\\d+\\.\\d+\\.\\d+$/"
 
 notifications:
   slack:
-    secure: 2tPcqxi5BQkomyLYTDk90JrI5iqm9TL5Hc9SklPVemtEUQdDqeEejNjBGIOxQeXxe6Vza/cVEVp8emmb0GQ25k36DeI82kvxWu/dtaXC2B73dr0zFw3IV6VpG9nUcmgNiHrTYDlK5C3QYlkYKDSrAlrBRLA16qiSIe2JpPSClI4=
+    secure: qAKVtBCrucCt8GB1SVjjCckwWqC6zAvXN7UdT+aFLH2u7vILT4jzLibTRAaTqqcBBnxFYE87qii4uaIbIltMRZYBQUyiz/mTabkQq5RHJKzzZq54qcKjrI7BSCJHoJErBYrNO4yECUgR6wkhF2/e0+OxEtuSxFovTGXN9ycMT0c=
 
 env:
   global:
     secure: P3baCsYCRF45nZExdjc3QzAt8PKqK9i+0M04N87I7UJgv8ibqPb2kVah/YXcRdAUxAN3vE095LALf4NszXKa3fx/QnsoyfQqnVpwmVbNM0cCScT3Du304j2XnwoSghvNT8bDlvT+qmhLr9N8xE3E6sodChMpYLNPqfJWSG1nOJY=
 
-addons:
-  coverity_scan:
-    project:
-      name: "openpreserve/jhove"
-      description: "File validation and characterisation"
-    notification_email: carl@openpreservation.org
-    build_command_prepend: "mvn clean"
-    build_command:   "mvn -DskipTests=true compile"
-    branch_pattern: integration
+coverage:
+  notify:
+    slack:
+      default:
+        url: "https://hooks.slack.com/services/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"
+        threshold: 1%
+        only_pulls: false
+        branches: null
+        flags: null
+        paths: null
 
 before_install:
-- sudo apt-get install -y realpath
+  - sudo apt-get install -y realpath
+  - sudo apt-get install jq
+  - wget -O ~/codacy-coverage-reporter-assembly-latest.jar $(curl https://api.github.com/repos/codacy/codacy-coverage-reporter/releases/latest
+    | jq -r .assets[0].browser_download_url)
 
 script:
-- mvn clean install
-- "./jhove-bbt/scripts/travis-test.sh"
+  - mvn clean install -DjacocoAgg
+  - "./jhove-bbt/scripts/travis-test.sh"
+  - mvn verify -DjacocoAgg
 
 after_success:
-- bash <(curl -s https://codecov.io/bash)
+  - bash <(curl -s https://codecov.io/bash)
+  - java -cp ~/codacy-coverage-reporter-assembly-latest.jar com.codacy.CodacyCoverageReporter
+    -l Java -r jhove-apps/target/site/jacoco-aggregate/jacoco.xml
 
 after_failure:
-- cat /tmp/bbt-logs/log.txt | grep --group-separator"===== Unexpected output =====" -n -B 1 -A 2 Expected
+  - cat /tmp/bbt-logs/log.txt | grep --group-separator"===== Unexpected output ====="
+    -n -B 1 -A 2 Expected

DOCUMENTATION.md

@@ -0,0 +1,19 @@
+Documentation
+=============
+This is a quick start guide for anyone who wants to contribute to the JHOVE documentation. The official home of the JHOVE documentation is now here: http://jhove.openpreservation.org/. This is a [GitHub pages](https://help.github.com/articles/what-is-github-pages/) hosted web site meaning:
+ - GitHub kindly host the site;
+ - the documentation is part of the GitHub project so that anyone can contribute changes.
+
+Pre-requisites
+--------------
+The bare minimum toolset needed to make changes to the documentation is a text editor and a knowledge of either [HTML](https://www.w3schools.com/html/) or [Markdown](https://daringfireball.net/projects/markdown/). The site also uses [Bootstrap](http://getbootstrap.com/) for look and feel but you can make changes without knowing any Bootstrap.
+
+How it Works
+------------
+The source code for the website is held in the specifically named `gh-pages` branch of the git project. You can [see it on GitHub](https://github.com/openpreserve/jhove/tree/gh-pages), the home page for the website is the [`index.html` file in the root directory](https://github.com/openpreserve/jhove/blob/gh-pages/index.html). The folders starting with and underscore, `_data`, `_includes`, and `_layouts` provide site structure and page layouts and need only interest the curious. The directories `css` and `img` contain site stylesheets and images respectively. The other directories correspond to content paths on the website, for example  `documentation/index.html` is the site's http://jhove.openpreservation.org/documentation/ page.
+
+### GitHub Pages, Jekyll and Markdown
+If you're unfamiliar with GitHub Pages then their home page: https://pages.github.com/ is a good starting point. Under the hood it uses [Jekyll](https://jekyllrb.com/) to convert the GitHub `gh-pages` branch to the website. This conversion puts together pages and converts any Markdown files to HTML. If you're unfamiliar with Markdown, this file is written in it. It's a text-to-HTML conversion tool meaning that files can be written in a friendly plain text format, then converted to HTML. GitHub provide a comprehensive guide to [writing on GitHub](https://help.github.com/categories/writing-on-github/) which covers their own GitHub flavoured markdown. The [JHOVE beginners guide](http://jhove.openpreservation.org/getting-started/beginners/) is written in Markdown, you can see the markdown for the page alone [in the repository here](https://github.com/openpreserve/jhove/blob/gh-pages/getting-started/beginners/index.md) and the [raw source text file here](https://raw.githubusercontent.com/openpreserve/jhove/gh-pages/getting-started/beginners/index.md).
+
+### DIY local site hosting
+If you're more technically inclined you can serve a version of the site locally. This will update as you make edits and makes working with the documentation very quick. GitHub have already produced a good guide to this https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/.