This is an automated email from the ASF dual-hosted git repository.
pottlinger pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/creadur-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 013ceeb7 RAT-343: Prepublish webpage
013ceeb7 is described below
commit 013ceeb71bdfa540dd529921867bf3ef2d137571
Author: Hugo Hirsch <[email protected]>
AuthorDate: Sun Jan 14 22:33:27 2024 +0100
RAT-343: Prepublish webpage
---
rat0161/apache-rat-core/rat-report.html | 2 +-
rat0161/apache-rat-plugin/dependencies.html | 2 +-
.../apache-rat-plugin/examples/custom-license.html | 27 ++++++++++++++++++----
rat0161/apache-rat-plugin/rat-report.html | 2 +-
rat0161/apache-rat-tasks/dependencies.html | 4 ++--
rat0161/apache-rat-tasks/rat-report.html | 2 +-
rat0161/apache-rat/rat-report.html | 2 +-
rat0161/rat-report.html | 2 +-
8 files changed, 31 insertions(+), 12 deletions(-)
diff --git a/rat0161/apache-rat-core/rat-report.html
b/rat0161/apache-rat-core/rat-report.html
index 92afb17e..eb587d44 100644
--- a/rat0161/apache-rat-core/rat-report.html
+++ b/rat0161/apache-rat-core/rat-report.html
@@ -118,7 +118,7 @@ Rat (Release Audit Tool) results
*****************************************************
Summary
-------
-Generated at: 2024-01-14T21:29:01+01:00
+Generated at: 2024-01-14T22:32:14+01:00
Notes: 2
Binaries: 3
diff --git a/rat0161/apache-rat-plugin/dependencies.html
b/rat0161/apache-rat-plugin/dependencies.html
index 1c3c7bf1..9277e2fb 100644
--- a/rat0161/apache-rat-plugin/dependencies.html
+++ b/rat0161/apache-rat-plugin/dependencies.html
@@ -2042,7 +2042,7 @@ Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z,
arj.</p>
<td align="center">-</td></tr>
<tr class="b">
<td align="left">apache-rat-core-0.16.1-SNAPSHOT-tests.jar</td>
-<td align="right">258.3 kB</td>
+<td align="right">263.3 kB</td>
<td align="right">-</td>
<td align="right">-</td>
<td align="right">-</td>
diff --git a/rat0161/apache-rat-plugin/examples/custom-license.html
b/rat0161/apache-rat-plugin/examples/custom-license.html
index 3397ee08..82326509 100644
--- a/rat0161/apache-rat-plugin/examples/custom-license.html
+++ b/rat0161/apache-rat-plugin/examples/custom-license.html
@@ -117,9 +117,10 @@ Custom License Matchers
<div id="contentBox">
<section>
<h2><a name="Custom_License_Matchers"></a>Custom License Matchers</h2>
-<p>Rat comes with a set of predefined license matchers, that can be used some
typical licenses. However, they will not always be sufficient. In such cases,
you may use a custom license matcher.</p>
-<p>The simplest way to create a license check is to create an XML file
describing the new license and add it to the processing with the
additionalLicenseFiles option. </p>
-<p>The second option is to define the custom license directly in the POM.
Unlike earlier version no custom implementations are required to define custom
licenses.</p>
+<p>Rat comes with a set of predefined license matchers, that can be used on
typical licenses. However, they will not always be sufficient. In such cases,
you may configure a custom license matcher.</p>
+<p>The simplest way to create a license check is to create an XML file
describing the new license and add it to the processing with the
additionalLicenseFiles option.</p>
+<p>The second option is to define the custom license directly in the POM.
Unlike earlier version (before 0.16) no custom implementations are required to
define custom licenses.</p>
+<p>There is a file that defines all of the standard licenses: <a
class="externalLink"
href="https://github.com/apache/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml";>default.xml</a></p>
<div>
<pre> /**
* Yet Another Software License, 1.0
@@ -187,7 +188,25 @@ Custom License Matchers
</plugin>
...
</plugins>
- </build></pre></div></section>
+ </build></pre></div></section><section>
+<h2><a name="Overview_of_configuration_options"></a>Overview of configuration
options</h2>
+<p>When defining custom licenses, remember the following architecture
constraints:</p>
+<ul>
+<li>Each license is associated with a family. Multiple licenses can be
associated with a family.</li>
+<li>Each license may have a notes element.</li>
+<li>Each license has one matcher.</li></ul><section>
+<h3><a name="Matcher_details"></a>Matcher details</h3>
+<p><b>all</b> - A collection of matchers in which all enclosed matchers have
to be true for the matcher to report true.</p>
+<p><b>any</b> - A collection of matchers that will report true if any enclosed
matcher is true.</p>
+<p><b>copyright</b> - A matcher that matches Copyright text. This uses regular
expressions and so should only be used when looking for copyrights with
specific patterns that are not caught by a standard text matcher. This matcher
will match <code>"(C)"</code>, <code>"copyright"</code>, or
<code>"©"</code>. (text is not case sensitive). It will also
match things like <code>Copyright (c) joe 1995</code> as well as
<code>Copyright (C) 1995 joe</code>. Copy [...]
+<ul>
+<li><b>start</b> - the starting date of the copyright or the only date.</li>
+<li><b>end</b> - the ending date of the copyright. Only valid if the starting
date is provided.</li>
+<li><b>owner</b> - the copyright owner.</li></ul>
+<p><b>not</b> - A matcher that wraps one matcher and negates its value. Not
matchers require that the entire header be read before it can report true or
false. This may significantly slow processing.</p>
+<p><b>regex</b> - A matcher that matches a regex string.</p>
+<p><b>spdx</b> - A matcher that matches SPDX tags. SPDX tags have the form:
<code>SPDX-License-Identifier: short-name</code>, where short-name matches the
regex pattern <code>"[A-Za-z0-9\.-]+".</code> spdx takes the short
name as an argument.</p>
+<p>If you define families and do not define <code>approvedFamilies</code> in
your pom all the families are assumed to be approved.</p></section></section>
</div>
</div>
<div class="clear">
diff --git a/rat0161/apache-rat-plugin/rat-report.html
b/rat0161/apache-rat-plugin/rat-report.html
index 379d939a..05863e76 100644
--- a/rat0161/apache-rat-plugin/rat-report.html
+++ b/rat0161/apache-rat-plugin/rat-report.html
@@ -133,7 +133,7 @@ Rat (Release Audit Tool) results
*****************************************************
Summary
-------
-Generated at: 2024-01-14T21:29:15+01:00
+Generated at: 2024-01-14T22:32:27+01:00
Notes: 0
Binaries: 0
diff --git a/rat0161/apache-rat-tasks/dependencies.html
b/rat0161/apache-rat-tasks/dependencies.html
index 8bddd866..09f4ac1a 100644
--- a/rat0161/apache-rat-tasks/dependencies.html
+++ b/rat0161/apache-rat-tasks/dependencies.html
@@ -757,7 +757,7 @@ Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z,
arj.</p>
<td align="center">-</td></tr>
<tr class="a">
<td align="left">apache-rat-core-0.16.1-SNAPSHOT-tests.jar</td>
-<td align="right">258.3 kB</td>
+<td align="right">263.3 kB</td>
<td align="right">-</td>
<td align="right">-</td>
<td align="right">-</td>
@@ -860,7 +860,7 @@ Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z,
arj.</p>
<td align="right">provided: 2</td></tr>
<tr class="b">
<td align="right">test: 13</td>
-<td align="right">test: 7.1 MB</td>
+<td align="right">test: 7.2 MB</td>
<td align="right">test: 4910</td>
<td align="right">test: 4661</td>
<td align="right">test: 148</td>
diff --git a/rat0161/apache-rat-tasks/rat-report.html
b/rat0161/apache-rat-tasks/rat-report.html
index 9f27f843..bed6942c 100644
--- a/rat0161/apache-rat-tasks/rat-report.html
+++ b/rat0161/apache-rat-tasks/rat-report.html
@@ -129,7 +129,7 @@ Rat (Release Audit Tool) results
*****************************************************
Summary
-------
-Generated at: 2024-01-14T21:29:24+01:00
+Generated at: 2024-01-14T22:32:35+01:00
Notes: 0
Binaries: 0
diff --git a/rat0161/apache-rat/rat-report.html
b/rat0161/apache-rat/rat-report.html
index 7ee97890..cca81780 100644
--- a/rat0161/apache-rat/rat-report.html
+++ b/rat0161/apache-rat/rat-report.html
@@ -115,7 +115,7 @@ Rat (Release Audit Tool) results
*****************************************************
Summary
-------
-Generated at: 2024-01-14T21:29:30+01:00
+Generated at: 2024-01-14T22:32:42+01:00
Notes: 1
Binaries: 0
diff --git a/rat0161/rat-report.html b/rat0161/rat-report.html
index 6c1114f6..1fabbf5d 100644
--- a/rat0161/rat-report.html
+++ b/rat0161/rat-report.html
@@ -118,7 +118,7 @@ Rat (Release Audit Tool) results
*****************************************************
Summary
-------
-Generated at: 2024-01-14T21:28:42+01:00
+Generated at: 2024-01-14T22:31:58+01:00
Notes: 5
Binaries: 0
