REL: v0.14.0 (#196)

* FEAT: Report blank namespaces (#187) - blank namespace prefixes are now reported as `<no-prefix>` in the `DOC-8` message`; - altered the `DOC-8` message to emphasise that prefixes are reported; - refactored out collection of namespaces into a Uitls class; and - removed trailing newline from `README` and template. * FIX: Pre-requisite handling (#188) - `POL-1` and `POL-2` are no longer pre-requisite rules, this means other policy rules will still run if these fail; - cleaned up a bug in pre-requisite handling where Validation reports weren't generated; - refactored the execution of Validation rules; and - removed a few unused imports. * REFACT: Tidied validator/profile calls (#189) * REFACT: Tidied validator/profile calls - profile is now invoked after validation rather than as a branch in CLI; - added profiling via `ValidationReport` as half-way house before interface refactor; - added Rule checking via `ValidationReport` and provided a simple method in `AbstractProfile` that calls existing `validate` method; - improved some variable and method names;and - made some CLI methods static. * FIX: Minor style issue. * REL: v0.14.0 (#190) - bumped Maven version to v0.14.0; - added updated versioned docs and README.md; and - udpdated Maven site and JavaDocs. * FIX: Pre-commit run. (#197) * REL: v0.14.0 - bumped Maven version to v0.14.0; - added updated versioned docs and README.md; and - udpdated Maven site and JavaDocs. * FIX: Pre-commit run.
openpreserve · Oct 16, 2024 · 184054e · 184054e
1 parent f04a783
commit 184054e
Show file tree

Hide file tree

Showing 365 changed files with 4,636 additions and 2,381 deletions.
diff --git a/.github/workflows/test-pr.yml b/.github/workflows/test-pr.yml
@@ -16,6 +16,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/action@v3.0.1
       - name: JDK setup
         uses: actions/setup-java@v3
         with:
@@ -25,7 +27,7 @@ jobs:
       - name: Build with Maven
         run: mvn --batch-mode --update-snapshots install -DjacocoAgg
       - name: Run pre-commit tests
-        uses: pre-commit/action@v3.0.0
+        uses: pre-commit/action@v3.0.1
         with:
           extra_args: --all-files --verbose
       - name: Test with Maven

diff --git a/README.md b/README.md
@@ -1,8 +1,7 @@
 # ODF Validator
 
-Latest version is 0.14.0-SNAPSHOT.
+Latest version is 0.14.0.
 
 ## About
 
 [Open Preservation Foundation](https://openpreservation.org/)'s OpenDocument Format Validator (OPF ODF Validator) enables your organisation to validate the file format standard and a set of file format policy rules created for improving the preservation effort of any files saved in the OpenDocument Format.
-
diff --git a/docs/developer/index.md b/docs/developer/index.md
@@ -44,7 +44,7 @@ To include the core validation library in your project, add the following depend
 <dependency>
     <groupId>org.openpreservation.odf</groupId>
     <artifactId>odf-core</artifactId>
-    <version>0.14.0-SNAPSHOT</version>
+    <version>0.14.0</version>
 </dependency>
 ```
 

diff --git a/docs/site/apidocs/allclasses-index.html b/docs/site/apidocs/allclasses-index.html
diff --git a/docs/site/apidocs/allpackages-index.html b/docs/site/apidocs/allpackages-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Tue Dec 19 09:20:39 GMT 2023 -->
-<title>All Packages (ODF spreadsheet validator. 0.10.0 API)</title>
+<!-- Generated by javadoc (17) on Mon Sep 30 10:59:03 BST 2024 -->
+<title>All Packages (ODF spreadsheet validator. 0.14.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-19">
+<meta name="dc.created" content="2024-09-30">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -83,7 +83,7 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 </main>
 <footer role="contentinfo">
 <hr>
-<p class="legal-copy"><small>Copyright &#169; 2022&#x2013;2023 <a href="http://www.openpreserve.org/">The Open Preservation Foundation</a>. All rights reserved.</small></p>
+<p class="legal-copy"><small>Copyright &#169; 2022&#x2013;2024 <a href="http://www.openpreserve.org/">The Open Preservation Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>

diff --git a/docs/site/apidocs/constant-values.html b/docs/site/apidocs/constant-values.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Tue Dec 19 09:20:39 GMT 2023 -->
-<title>Constant Field Values (ODF spreadsheet validator. 0.10.0 API)</title>
+<!-- Generated by javadoc (17) on Mon Sep 30 10:59:03 BST 2024 -->
+<title>Constant Field Values (ODF spreadsheet validator. 0.14.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-19">
+<meta name="dc.created" content="2024-09-30">
 <meta name="description" content="summary of constants">
 <meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -161,7 +161,7 @@ <h2 title="org.openpreservation">org.openpreservation.*</h2>
 </main>
 <footer role="contentinfo">
 <hr>
-<p class="legal-copy"><small>Copyright &#169; 2022&#x2013;2023 <a href="http://www.openpreserve.org/">The Open Preservation Foundation</a>. All rights reserved.</small></p>
+<p class="legal-copy"><small>Copyright &#169; 2022&#x2013;2024 <a href="http://www.openpreserve.org/">The Open Preservation Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>

diff --git a/docs/site/apidocs/help-doc.html b/docs/site/apidocs/help-doc.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Tue Dec 19 09:20:39 GMT 2023 -->
-<title>API Help (ODF spreadsheet validator. 0.10.0 API)</title>
+<!-- Generated by javadoc (17) on Mon Sep 30 10:59:03 BST 2024 -->
+<title>API Help (ODF spreadsheet validator. 0.14.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-19">
+<meta name="dc.created" content="2024-09-30">
 <meta name="description" content="help">
 <meta name="generator" content="javadoc/HelpWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -71,6 +71,7 @@ <h1 class="title">JavaDoc Help</h1>
 <li><a href="#use">Use</a></li>
 <li><a href="#tree">Tree (Class Hierarchy)</a></li>
 <li><a href="#constant-values">Constant Field Values</a></li>
+<li><a href="#serialized-form">Serialized Form</a></li>
 <li><a href="#all-packages">All Packages</a></li>
 <li><a href="#all-classes">All Classes and Interfaces</a></li>
 <li><a href="#index">Index</a></li>
@@ -166,6 +167,10 @@ <h3>Tree (Class Hierarchy)</h3>
 <h3>Constant Field Values</h3>
 <p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
 </section>
+<section class="help-section" id="serialized-form">
+<h3>Serialized Form</h3>
+<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.</p>
+</section>
 <section class="help-section" id="all-packages">
 <h3>All Packages</h3>
 <p>The <a href="allpackages-index.html">All Packages</a> page contains an alphabetic index of all packages contained in the documentation.</p>
@@ -183,7 +188,7 @@ <h3>Index</h3>
 <span class="help-footnote">This help file applies to API documentation generated by the standard doclet.</span></main>
 <footer role="contentinfo">
 <hr>
-<p class="legal-copy"><small>Copyright &#169; 2022&#x2013;2023 <a href="http://www.openpreserve.org/">The Open Preservation Foundation</a>. All rights reserved.</small></p>
+<p class="legal-copy"><small>Copyright &#169; 2022&#x2013;2024 <a href="http://www.openpreserve.org/">The Open Preservation Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>