chore: prepare release v4.1.0

- add a change log - update the POM version to 4.1.0-SNAPSHOT - change the distribution README
w3c · Nov 26, 2018 · 390b293 · 390b293
1 parent dfd7fd2
commit 390b293
Show file tree

Hide file tree

Showing 4 changed files with 135 additions and 49 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,69 @@
+# EPUBCheck change log
+
+<a name="4.1.0"></a>
+## [4.1.0](https://github.com/w3c/epubcheck/compare/v4.0.2...v4.1.0) (2018-11-26)
+
+This is a maintenance release of EPUBCheck, the conformance validator for EPUB publications. It includes various improvements and bug fixes that have been contributed over the past two years.
+
+This release was made by the DAISY Consortium, for the W3C.
+
+Many thanks to the various people who contributed to this release, including  @bitsgalore, @kalaspuffar, @kamorrissey, @matthew-macgregor, @mkraetke, @murata2makoto, @takahashim, @tledoux… and especially Tobias Fischer (@tofi86), who has been the primary project maintainer after v4.0.2 and before the DAISY Consortium took over the maintenance role in October 2018!
+
+**Note:** this release does _not_ yet implement support for the newer EPUB 3.2 specifications.
+
+### Bug Fixes
+
+* silence a Saxon warning (Schematron XSLT) ([5045d78b](https://github.com/w3c/epubcheck/commit/5045d78b)), closes #859
+* fix path resolution in EpubNCXCheck (ctc package) ([f572a861](https://github.com/w3c/epubcheck/commit/f572a861))
+* handle `IllegalStateException` in NCX checker ([25336894](https://github.com/w3c/epubcheck/commit/25336894)), closes #666
+* check that the `mimetype` file is uncompressed ([6764e250](https://github.com/w3c/epubcheck/commit/6764e250)), closes #303
+* fix wrong exit message for single file validation ([68af5a9a](https://github.com/w3c/epubcheck/commit/68af5a9a)), closes #740
+* allow ARIA `role` attributes in SVG ([49412e05](https://github.com/w3c/epubcheck/commit/49412e05)), closes #769
+* allow empty `xml:lang` attributes ([392c2f68](https://github.com/w3c/epubcheck/commit/392c2f68)), closes #777
+* handle no src uri in fonts, correct embedded font boolean in the XML output ([a26f9c13](https://github.com/w3c/epubcheck/commit/a26f9c13)), closes #773
+* fix issues with landmarks checks `ACC-008` ([74d0bdd1](https://github.com/w3c/epubcheck/commit/74d0bdd1)), closes #457, #734
+* fix focus issue when using EPUBCheck in a GUI app ([cd63a166](https://github.com/w3c/epubcheck/commit/cd63a166)), closes #665
+* fix incorrect warning `ACC_011` ([5e6a69af](https://github.com/w3c/epubcheck/commit/5e6a69af)), closes #680
+* make the `type` attribute optional on SVG `style` elements ([275f6b6a](https://github.com/w3c/epubcheck/commit/275f6b6a)), closes #688
+* exit with error when directory is not found in expanded mode ([e42d189c](https://github.com/w3c/epubcheck/commit/e42d189c)), closes #525
+* fix a `NullPointerException` when checking an empty meta rendition element in OPF ([42d75297](https://github.com/w3c/epubcheck/commit/42d75297)), closes #727
+* fix `DefaultReportImpl` to avoid duplicate path info in message locations ([9321355b](https://github.com/w3c/epubcheck/commit/9321355b)), closes #729
+* fix broken `OPF_060` and `OPF_061` message format ([9f0e7d12](https://github.com/w3c/epubcheck/commit/9f0e7d12)), closes #658
+* fix broken `OPF_060` and `OPF_061` checks for duplicate ZIP entries ([05e96f40](https://github.com/w3c/epubcheck/commit/05e96f40)), closes #728
+
+### Features
+
+* allow the configuration of EPUBCheck’s locale ([9b249956](https://github.com/w3c/epubcheck/commit/9b249956)), closes #650, #498
+* report invalid `dc:identifier` UUIDs validation (as `WARNING`) ([48800a04](https://github.com/w3c/epubcheck/commit/48800a04)), closes #853
+* change `--version` and `-version` command line options to output EPUBCheck version ([e498c61d](https://github.com/w3c/epubcheck/commit/e498c61d)), closes #743
+* check files with extensions other than `.epub` ([1b67e046](https://github.com/w3c/epubcheck/commit/1b67e046)), closes #490
+* report `file://` URL as `INFO` ([8f7a2b7d](https://github.com/w3c/epubcheck/commit/8f7a2b7d)), closes #289
+* improve messages for `OPF-058` and `OPF-059` ([5e33645e](https://github.com/w3c/epubcheck/commit/5e33645e)), closes #804
+* enable `NCX_001` check also for EPUB 3 when an NCX file is present ([9715c352](https://github.com/w3c/epubcheck/commit/9715c352))
+* report non-matching identifiers in OPF and NCX as an error again ([515682dc](https://github.com/w3c/epubcheck/commit/515682dc))
+* improved css font size validation ([25c0b372](https://github.com/w3c/epubcheck/commit/25c0b372)), closes #529
+* issue a `WARNING` when landmarks anchors are not unique ([557308ef](https://github.com/w3c/epubcheck/commit/557308ef)), closes #493
+* issue a `WARNING` when guide/reference elements are not unique ([25f28c01](https://github.com/w3c/epubcheck/commit/25f28c01)), closes #493
+* partial update of OPF 2.0 RelaxNG schema to latest version (changing datatype `text` to `anyURI` for `href` attributes) ([251aa936](https://github.com/w3c/epubcheck/commit/251aa936)), closes #725
+* display error/warning count in EPUBCheck results ([b7babedf](https://github.com/w3c/epubcheck/commit/b7babedf)), closes #655
+* add file path info in `uri` attributes of the XML report ([c958c117](https://github.com/w3c/epubcheck/commit/c958c117)), closes #540
+* update the XHTML 1.1 RelaxNG schema to latest version ([4c6fb49a](https://github.com/w3c/epubcheck/commit/4c6fb49a))
+* update the OPF20 RNG schema in sync with official schema to validate empty guide elements ([6540b03d](https://github.com/w3c/epubcheck/commit/6540b03d))
+* report an `ERROR` when `@clipBegin` equals `@clipEnd` in SMIL Media Overlays ([00716768](https://github.com/w3c/epubcheck/commit/00716768)), closes #568
+* improve Nav Doc validation ([d32de854](https://github.com/w3c/epubcheck/commit/d32de854)), closes #763, #759
+* update the NCX RelaxNG schema to add fixed list of `pageTarget` type values ([b2c9e939](https://github.com/w3c/epubcheck/commit/b2c9e939)), closes #761
+* improve URL checks ([a44a596b](https://github.com/w3c/epubcheck/commit/a44a596b)), closes #708
+* rephrase messages `RSC-005`, `RSC-016`, `RSC-017` ([5ef44973](https://github.com/w3c/epubcheck/commit/5ef44973))
+* add JHove XSD schema declaration in XML output ([e55039c9](https://github.com/w3c/epubcheck/commit/e55039c9)), closes #736
+* add detailed resource info in `RSC-008` messages ([5f5ef7b7](https://github.com/w3c/epubcheck/commit/5f5ef7b7)), closes #720
+* add detailed resource info in `RSC-007` messages ([71a76ee4](https://github.com/w3c/epubcheck/commit/71a76ee4)), closes #475
+
+### Maintenance
+
+* change the project name to 'EPUBCheck' ([dfd7fd27](https://github.com/w3c/epubcheck/commit/dfd7fd27))
+* update the minimum source code compatibility to Java 1.7 ([9b249956](https://github.com/w3c/epubcheck/commit/9b249956))
+* update the Saxon dependency to v9.8 ([bf10f380](https://github.com/w3c/epubcheck/commit/bf10f380))
+* update the Apache `commons-compress` dependency  to v1.18 ([e7dfedd8](https://github.com/w3c/epubcheck/commit/e7dfedd8))
+* update the Google Guava dependency to v24.0 ([befd9fc3](https://github.com/w3c/epubcheck/commit/befd9fc3))
+* update the continuous integration build matrix, now testing from Java 7 up to Java 11 ([fb84b23c](https://github.com/w3c/epubcheck/commit/fb84b23c))
+* various translation updates ([39a9a093](https://github.com/w3c/epubcheck/commit/39a9a093), [6e3a8b41](https://github.com/w3c/epubcheck/commit/6e3a8b41))
diff --git a/pom.xml b/pom.xml
@@ -11,7 +11,7 @@
 
     <groupId>org.idpf</groupId>
     <artifactId>epubcheck</artifactId>
-    <version>4.0.3-SNAPSHOT</version>
+    <version>4.1.0-SNAPSHOT</version>
 
     <packaging>jar</packaging>
 

diff --git a/src/main/assembly/README-dist.txt b/src/main/assembly/README-dist.txt
@@ -1,75 +1,89 @@
-This folder contains the distribution of EPUBCheck project.
+EPUBCheck
+=========
 
-EPUBCheck is a tool to validate EPUB files. It can detect many
-types of errors in EPUB. OCF container structure, OPF and OPS mark-up,
-and internal reference consistency are checked. EPUBCheck can be run
-as a standalone command-line tool, installed as a web application or
-used as a Java library.
+This folder contains the distribution of the EPUBCheck project.
+
+EPUBCheck is a tool to validate the conformance of EPUB publications against
+the EPUB specifications. EPUBCheck can be run as a standalone command-line tool
+or used as a Java library.
 
 EPUBCheck project home: https://github.com/idpf/epubcheck
 
 
 RUNNING
+-------
+
+To run the tool you need a Java runtime (1.7 or above).
+Any Operating System should do. 
 
-To run the tool you need Java (1.6 or above, 1.7+ recommended).
-Any Operating System should do. Run it from the command line:
+Run it from the command line:
 
-  java -jar epubcheck.jar file.epub
+>  java -jar epubcheck.jar file.epub
 
-All detected errors are simply printed to stderr.
+All detected errors are simply printed to the standard error stream.
 
 Print the commandline help with the --help argument:
-  java -jar epubcheck.jar --help
+
+>  java -jar epubcheck.jar --help
 
 
 USING AS A LIBRARY
+------------------
 
 You can also use EPUBCheck as a library in your Java application. EPUBCheck
-public interfaces can be found in com.adobe.epubcheck.api package. EPUBCheck
-class can be used to instantiate a validation engine. Use one of its
-constructors and then call validate() method. Report is an interface that
-you can implement to get a list of the errors and warnings reported by the
+public interfaces can be found in the `com.adobe.epubcheck.api package`.
+EPUBCheck class can be used to instantiate a validation engine. Use one of its
+constructors and then call validate() method. Report is an interface that you
+can implement to get a list of the errors and warnings reported by the
 validation engine (instead of the error list being printed out).
 
 
 LICENSING
+---------
 
-See COPYING.txt and THIRD-PARTY.txt
+EPUBCheck is made available under the terms of the New BSD License.
 
+See details in COPYING.txt and THIRD-PARTY.txt
 
-AUTHORS / CONTRIBUTORS
 
-Peter Sorotokin
-Garth Conboy
-Markus Gylling
-Piotr Kula
-Paul Norton
-Jessica Hekman
-Liza Daly
-George Bina
-Bogdan Iordache
-Ionut-Maxim Margelatu
-Romain Deltour
-Steve Antoch
-Arwen Pond
-Thomas Ledoux
-Tobias Fischer
-Masayoshi Takahashi
-Satoshi KOJIMA
-Emiliano Molina
-Jostein Austvik Jacobsen
-Stephan Kreutzer
-Alberto Pettarin
-MURATA Makoto
-Tomohiko Hayashi
-Matt Garrish
-dilbirligi
-Francisco Sanchez
-Andrew Neitsch
-Alexander Walters
-Dave Cramer
-Tzviya Siegman
-Martin Kraetke
+AUTHORS / CONTRIBUTORS
+----------------------
+
+This distribution of EPUBCheck was made by the DAISY Consortium, for the W3C.
+
+Previous contributors include:
+
+- Alberto Pettarin
+- Alexander Walters
+- Andrew Neitsch
+- Arwen Pond
+- Bogdan Iordache
+- Dave Cramer
+- dilbirligi
+- Emiliano Molina
+- Francisco Sanchez
+- Garth Conboy
+- George Bina
+- Ionut-Maxim Margelatu
+- Jessica Hekman
+- Jostein Austvik Jacobsen
+- Liza Daly
+- Markus Gylling
+- Martin Kraetke
+- Masayoshi Takahashi
+- Matt Garrish
+- MURATA Makoto
+- Paul Norton
+- Peter Sorotokin
+- Piotr Kula
+- Romain Deltour
+- Satoshi KOJIMA
+- Stephan Kreutzer
+- Steve Antoch
+- Thomas Ledoux
+- Tobias Fischer
+- Tomohiko Hayashi
+- Tzviya Siegman
 
 
 Most of the EPUBCheck functionality comes from the schema validation tool Jing

diff --git a/src/main/assembly/dist.xml b/src/main/assembly/dist.xml
@@ -10,6 +10,9 @@
         <file>
             <source>COPYING.txt</source>
         </file>
+        <file>
+            <source>CHANGELOG.md</source>
+        </file>
         <file>
             <source>src/main/assembly/README-dist.txt</source>
             <destName>README.txt</destName>