This is an automated email from the ASF dual-hosted git repository.
claude pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/creadur-rat.git
The following commit(s) were added to refs/heads/master by this push:
new 99cb76e4 RAT-397: Migrate RAT to new site stack and prepare for
upcoming Doxia 2.x migration (#386)
99cb76e4 is described below
commit 99cb76e4e440fc34dfcf5aaf2016d378eed86a5e
Author: P. Ottlinger <[email protected]>
AuthorDate: Sat Aug 2 18:24:33 2025 +0200
RAT-397: Migrate RAT to new site stack and prepare for upcoming Doxia 2.x
migration (#386)
* RAT-397: Migrate webpage to newer site-plugin stack and change skin of
site. Removed some of the reports as plugins are discontinued. Rename to RAT
consistently. Allow deployment of site next to old version in rat017,
---------
Co-authored-by: Jochen Wiedmann <[email protected]>
Co-authored-by: Jochen Wiedmann <[email protected]>
---
.buildtools/formatPom | 1 +
.buildtools/{formatPom => formatSiteXml} | 7 +-
.buildtools/generateStagingSiteInWebpageRepo | 1 +
.../generateStagingSiteInWebpageRepo-release | 1 +
README.md | 2 +-
ant-task-examples.xml | 16 +--
.../org/apache/rat/report/xml/XmlElements.java | 6 +-
.../apache/rat/report/xml/writer/IXmlWriter.java | 4 +-
apache-rat-core/src/site/apt/index.apt.vm | 10 +-
.../src/site/markdown/development/document_name.md | 8 +-
.../src/site/markdown/exclusion_expression.md | 12 +-
apache-rat-core/src/site/site.xml | 15 +--
apache-rat-plugin/src/changes/changes.xml | 2 +-
.../org/apache/rat/mp/rat-report.properties | 6 +-
.../java/org/apache/rat/mp/RatCheckException.java | 2 +-
.../main/java/org/apache/rat/mp/RatCheckMojo.java | 4 +-
.../main/java/org/apache/rat/mp/RatReportMojo.java | 2 +-
.../src/site/apt/examples/custom-license.apt.vm | 2 +-
apache-rat-plugin/src/site/site.xml | 15 +--
apache-rat-tasks/run-antunit.xml | 2 +-
.../src/site/apt/examples/basic.apt.vm | 18 +--
apache-rat-tasks/src/site/apt/examples/report.apt | 6 +-
apache-rat-tasks/src/site/site.xml | 17 +--
apache-rat-tasks/src/templates/apt/index.apt.vm.vm | 2 +-
.../src/test/resources/antunit/report-junit.xml | 3 -
.../resources/antunit/report-normal-operation.xml | 16 +--
.../src/test/resources/antunit/report-options.xml | 1 -
apache-rat-tools/src/site/apt/index.apt.vm | 4 +-
apache-rat-tools/src/site/site.xml | 17 +--
apache-rat/README-ANT.txt | 4 +-
apache-rat/README-CLI.txt | 12 +-
apache-rat/src/site/apt/name_xref.apt.vm | 6 +-
apache-rat/src/site/apt/xsd.apt.vm | 14 ++-
apache-rat/src/site/resources/site/index.md.vm | 2 +-
apache-rat/src/site/site.xml | 15 +--
.../src/templates/apt/default_licenses.apt.vm | 4 +-
pom.xml | 79 +++++++++++--
src/changes/changes.xml | 6 +
src/changes/release-notes.vm | 2 +-
src/site/apt/index.apt.vm | 2 +-
src/site/markdown/development/ui/generator.md | 2 +-
src/site/site.xml | 127 +++++++++------------
42 files changed, 251 insertions(+), 226 deletions(-)
diff --git a/.buildtools/formatPom b/.buildtools/formatPom
index 484b8a5f..968d8c0e 100755
--- a/.buildtools/formatPom
+++ b/.buildtools/formatPom
@@ -1,3 +1,4 @@
+#!/bin/bash
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
diff --git a/.buildtools/formatPom b/.buildtools/formatSiteXml
similarity index 87%
copy from .buildtools/formatPom
copy to .buildtools/formatSiteXml
index 484b8a5f..3111980b 100755
--- a/.buildtools/formatPom
+++ b/.buildtools/formatSiteXml
@@ -1,3 +1,4 @@
+#!/bin/bash
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
@@ -13,8 +14,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
-for pom in `find . -name \pom.xml`
+for siteDesc in `find . -name \site.xml`
do
- xmllint --format $pom > /tmp/w
- mv /tmp/w $pom
+ xmllint --format $siteDesc > /tmp/w
+ mv /tmp/w $siteDesc
done
diff --git a/.buildtools/generateStagingSiteInWebpageRepo
b/.buildtools/generateStagingSiteInWebpageRepo
index a1825d4f..6a2ee494 100755
--- a/.buildtools/generateStagingSiteInWebpageRepo
+++ b/.buildtools/generateStagingSiteInWebpageRepo
@@ -1,3 +1,4 @@
+#!/bin/bash
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
diff --git a/.buildtools/generateStagingSiteInWebpageRepo-release
b/.buildtools/generateStagingSiteInWebpageRepo-release
index 85c262b0..8b2e7fa1 100755
--- a/.buildtools/generateStagingSiteInWebpageRepo-release
+++ b/.buildtools/generateStagingSiteInWebpageRepo-release
@@ -1,3 +1,4 @@
+#!/bin/bash
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
diff --git a/README.md b/README.md
index 5cb02b42..3b3e719d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Apache Creadur Rat - Build status
+# Apache Creadur RAT - Build status
ASF Jenkins: [](https://ci-builds.apache.org/job/Creadur/job/Creadur-Rat/)
diff --git a/ant-task-examples.xml b/ant-task-examples.xml
index 0bd7d6c4..ac18ad3d 100644
--- a/ant-task-examples.xml
+++ b/ant-task-examples.xml
@@ -30,7 +30,7 @@
location="apache-rat-core/target/apache-rat-core-${version}-sources.jar"/>
<target name="javasources" depends="-taskdef"
- description="runs the tasks over Rat's source tree excluding the license
directory">
+ description="runs the tasks over RAT's source tree excluding the license
directory">
<rat:report xmlns:rat="antlib:org.apache.rat.anttasks">
<fileset dir="${src-dir}">
<exclude name="rat/license/"/>
@@ -39,14 +39,14 @@
</target>
<target name="jar" depends="-taskdef"
- description="runs the task over Rat's source tree">
+ description="runs the task over RAT's source tree">
<rat:report xmlns:rat="antlib:org.apache.rat.anttasks">
<zipfileset src="${src-jar}"/>
</rat:report>
</target>
<target name="tarball" depends="-taskdef"
- description="creates a tarball of Rat's source tree and runs the task over
the tarball">
+ description="creates a tarball of RAT's source tree and runs the task over
the tarball">
<tar destfile="ratsrc.tar.gz" compression="gzip">
<fileset dir="${src-dir}"/>
</tar>
@@ -61,7 +61,7 @@
</target>
<target name="javasources-w3c" depends="-taskdef"
- description="runs the tasks over Rat's source tree accepting only the W3C
license">
+ description="runs the tasks over RAT's source tree accepting only the W3C
license">
<rat:report xmlns:rat="antlib:org.apache.rat.anttasks"
addDefaultLicenseMatchers="false">
<fileset dir="${src-dir}"/>
@@ -72,7 +72,7 @@
</target>
<target name="url" depends="-taskdef"
- description="runs the task on the ASF's homepage">
+ description="runs the task on the ASF homepage">
<rat:report xmlns:rat="antlib:org.apache.rat.anttasks">
<url url="https://www.apache.org/"/>
</rat:report>
@@ -85,7 +85,7 @@
</target>
<target name="run-on-rat-output-xml" depends="-taskdef"
- description="Runs Rat on its own source tree and creates an XML
report">
+ description="Runs RAT on its own source tree and creates an XML
report">
<rat:report xmlns:rat="antlib:org.apache.rat.anttasks"
format="xml" reportFile="rat-report.xml">
<fileset dir="."/>
@@ -93,7 +93,7 @@
</target>
<target name="run-on-rat-output-styled" depends="-taskdef"
- description="Runs Rat on its own source tree and creates a report
using XSLT">
+ description="Runs RAT on its own source tree and creates a report
using XSLT">
<rat:report xmlns:rat="antlib:org.apache.rat.anttasks"
format="styled" reportFile="rat-report.txt">
<stylesheet>
@@ -104,7 +104,7 @@
</target>
<target name="restrict" depends="-taskdef"
- description="Run Rat on all files in this source tree that have been
modified today">
+ description="Run RAT on all files in this source tree that have been
modified today">
<tstamp/>
<rat:report xmlns:rat="antlib:org.apache.rat.anttasks">
<restrict>
diff --git
a/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlElements.java
b/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlElements.java
index e9eabaab..e8301aa8 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlElements.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlElements.java
@@ -50,9 +50,9 @@ public class XmlElements {
* The elements in the report.
*/
public enum Elements {
- /** The start of the Rat report */
+ /** The start of the RAT report */
RAT_REPORT("rat-report"),
- /** The version of Rat being run */
+ /** The version of RAT being run */
VERSION(),
/** A resource element */
RESOURCE(),
@@ -141,7 +141,7 @@ public class XmlElements {
}
/**
- * Create the Rat report element. Includes the timestamp and the version
element.
+ * Create the RAT report element. Includes the timestamp and the version
element.
* @return this.
* @throws RatException on error
*/
diff --git
a/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java
b/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java
index a2123692..1375bbee 100644
---
a/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java
+++
b/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java
@@ -30,7 +30,7 @@ import org.apache.rat.report.xml.XmlElements;
public interface IXmlWriter extends AutoCloseable {
/**
- * Starts a document by writing a prolog.
+ * Starts a document by writing a prologue.
* Calling this method is optional.
* When writing a document fragment, it should <em>not</em> be called.
* @return this object
@@ -56,7 +56,7 @@ public interface IXmlWriter extends AutoCloseable {
*
* @param element the element, not null
* @return this object
- * @throws InvalidXmlException if the name is not valid for an xml element
+ * @throws InvalidXmlException if the name is not valid for a xml element
* @throws OperationNotAllowedException
* if called after the first element has been closed
*/
diff --git a/apache-rat-core/src/site/apt/index.apt.vm
b/apache-rat-core/src/site/apt/index.apt.vm
index fbd960c9..f58071fe 100644
--- a/apache-rat-core/src/site/apt/index.apt.vm
+++ b/apache-rat-core/src/site/apt/index.apt.vm
@@ -19,16 +19,16 @@
Core Module
--------------------------
-About Apache Rat
+About Apache RAT
- Rat audits software distributions, with a special interest in headers.
+ RAT audits software distributions, with a special interest in headers.
If this isn't quite what you're looking for then take a look at the
other products developed by {{{https://creadur.apache.org}Apache Creadur}},
including {{{https://creadur.apache.org/whisker}Apache Whisker}} which audits
and generates legal (for example <<<LICENSE>>>) documents for
complex software distributions.
-Developing Rat
+Developing RAT
* Introducing the Modules
@@ -36,7 +36,7 @@ Developing Rat
engine. Other modules allow this engine to be run in various ways.
*----------+--------------+----------------+
- <<Runs Rat via>> | <<Requires>> | <<Module>> |
+ <<Runs RAT via>> | <<Requires>> | <<Module>> |
*----------+--------------+----------------+
An Ant task | {{{https://ant.apache.org}Apache Ant}} |
{{{../apache-rat-tasks}apache-rat-tasks}} |
*----------+--------------+----------------+
@@ -44,7 +44,7 @@ Developing Rat
*----------+--------------+----------------+
A Maven plugin | {{{https://maven.apache.org}Apache Maven}} |
{{{../apache-rat-plugin}apache-rat-plugin}} |
*----------+--------------+----------------+
-<<Modules that run Rat>>
+<<Modules that run RAT>>
Support for new build tools and alternative ways to run RAT should be coded
in new modules building on <<<apache-rat-core>>>. Developers interested in
diff --git a/apache-rat-core/src/site/markdown/development/document_name.md
b/apache-rat-core/src/site/markdown/development/document_name.md
index 23a3a474..2ffde82c 100644
--- a/apache-rat-core/src/site/markdown/development/document_name.md
+++ b/apache-rat-core/src/site/markdown/development/document_name.md
@@ -16,16 +16,16 @@
-->
# Document Names
-Rat must be able to distinguish files in multiple file systems; most notably
Windows® and Linux®. In addition, we want Rat to produce reports that
are comparable across the platforms. To achieve these goals the
`org.apache.rat.document.impl.DocumentName` class was developed.
+RAT must be able to distinguish files in multiple file systems; most notably
Windows® and Linux®. In addition, we want RAT to produce reports that
are comparable across the platforms. To achieve these goals the
`org.apache.rat.document.impl.DocumentName` class was developed.
-All documents in the Rat system have a base directory. Different UIs will set
the base directory differently. For example:
+All documents in the RAT system have a base directory. Different UIs will set
the base directory differently. For example:
* The command line sets the base directory to the directory or archive
specified on the command line.
* Ant UI sets the base directory to the directory where the `build.xml` file
is located.
* Maven UI sets the base directory to the directory where the project is
located.
* Other UIs may define the base directory as it fits the underlying build
system.
-When reporting a document Rat will report the path from the base directory to
the file; the path relative to the base directory.
+When reporting a document RAT will report the path from the base directory to
the file; the path relative to the base directory.
The `DocumentName` comprises:
@@ -39,7 +39,7 @@ The class `DocumentName` also provides a static value that
identifies the case-s
`DocumentName` also provides methods to:
* Resolve a name: This method takes a path relative to the DocumentName and
creates a new DocumentName instance with the same baseName, dirSeparator and
case-sensitivity flag is the original DocumentName.
-* Localize a name: This method returns the path from the baseName to the file.
It utilizes the dirSeparator to separate the directories.
+* Localize a name: This method returns the path from the baseName to the file.
It utilizes the dirSeparator to separate the directories.
* Localize with separator: This method returns the path from the baseName to
the file but utilizes a specified string as the directory separator.
* Short name: This method returns the last segment of the name.
diff --git a/apache-rat-core/src/site/markdown/exclusion_expression.md
b/apache-rat-core/src/site/markdown/exclusion_expression.md
index 11a8f79e..30f150aa 100644
--- a/apache-rat-core/src/site/markdown/exclusion_expression.md
+++ b/apache-rat-core/src/site/markdown/exclusion_expression.md
@@ -15,14 +15,14 @@
limitations under the License.
-->
-# Rat Exclusion Expressions
+# RAT Exclusion Expressions
-Rat uses a variation on the Ant or Git exclusion syntax.
+RAT uses a variation on the Ant or Git exclusion syntax.
-* `?` matches a single character. For example 'ca?' will match 'cat' and
'can' but not 'call' or the abbreviation for california (or Canada) 'CA'.
+* `?` matches a single character. For example 'ca?' will match 'cat' and 'can'
but not 'call' or the abbreviation for california (or Canada) 'CA'.
* `*` matches zero or more characters. For example 'ca*' will match 'cat',
'can', 'call' and the abbreviation for california (or Canada) 'CA'.
-* `**` matches zero or more directories. For example '**/ca?' will match
'my/cat', 'my/can', 'the/cat', 'the/can', 'cat' and 'can'.
-* `!` reverses the meaning of the expression. Example "!ca?" will not match
"cat" or "can". See include/exclude notes below.
+* `**` matches zero or more directories. For example '**/ca?' will match
'my/cat', 'my/can', 'the/cat', 'the/can', 'cat' and 'can'.
+* `!` reverses the meaning of the expression. Example "!ca?" will not match
"cat" or "can". See include/exclude notes below.
The table below shows an example of how the `*` and `**` differ and interact.
@@ -54,4 +54,4 @@ Patterns may use either '/' or '\\' as the path separation
character. '/' is rec
## Case sensitivity
-The case sensitivity of the matching patterns depends upon the file system in
use. If the file is case-sensitive then the matches are case-sensitive.
+The case sensitivity of the matching patterns depends upon the file system in
use. If the file is case-sensitive then the matches are case-sensitive.
diff --git a/apache-rat-core/src/site/site.xml
b/apache-rat-core/src/site/site.xml
index 4440bc8a..bc89c890 100644
--- a/apache-rat-core/src/site/site.xml
+++ b/apache-rat-core/src/site/site.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" ?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,15 +15,10 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/DECORATION/1.3.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0
http://maven.apache.org/xsd/decoration-1.3.0.xsd";
- name="Apache Rat™ Core">
- <body>
- <head>
- <![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]>
- </head>
-
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT™ Core">
+ <body>
+ <head><![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]></head>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
-</project>
+</site>
diff --git a/apache-rat-plugin/src/changes/changes.xml
b/apache-rat-plugin/src/changes/changes.xml
index b0d266b1..9506b2c8 100644
--- a/apache-rat-plugin/src/changes/changes.xml
+++ b/apache-rat-plugin/src/changes/changes.xml
@@ -17,7 +17,7 @@
-->
<document>
<properties>
- <title>Changes in the Rat Maven Plugin</title>
+ <title>Changes in the RAT Maven Plugin</title>
</properties>
<body>
<release version="0.12" date="Not yet released">
diff --git
a/apache-rat-plugin/src/main/filtered-resources/org/apache/rat/mp/rat-report.properties
b/apache-rat-plugin/src/main/filtered-resources/org/apache/rat/mp/rat-report.properties
index 48a38287..596b61eb 100644
---
a/apache-rat-plugin/src/main/filtered-resources/org/apache/rat/mp/rat-report.properties
+++
b/apache-rat-plugin/src/main/filtered-resources/org/apache/rat/mp/rat-report.properties
@@ -15,9 +15,9 @@
# limitations under the License.
#
-report.rat.name=Rat Report
+report.rat.name=RAT Report
report.rat.description=Report on compliance to license related source code
policies
-report.rat.title=Rat (Release Audit Tool) results
+report.rat.title=RAT (Release Audit Tool) results
report.rat.link=The following document contains the results of
-report.rat.fullName=Rat (Release Audit Tool)
+report.rat.fullName=RAT (Release Audit Tool)
report.rat.url=${project.url}
diff --git
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckException.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckException.java
index 57a55732..8faf78a9 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckException.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckException.java
@@ -22,7 +22,7 @@ package org.apache.rat.mp;
import org.apache.maven.plugin.MojoFailureException;
/**
- * Exception thrown when Plugin processing encounters an error not found in
Core system.
+ * Exception thrown when plugin processing encounters an error not found in
the core system.
*/
public class RatCheckException extends MojoFailureException {
private static final long serialVersionUID = -1720861476741779140L;
diff --git
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
index 13631978..bb17a6b5 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
@@ -40,9 +40,9 @@ import org.apache.rat.utils.DefaultLog;
import static java.lang.String.format;
/**
- * Run Rat to perform a violation check.
+ * Run RAT to perform a violation check.
* <p>
- * This documentation mentions data types for some of the arguments. An <a
href="data_types.html">explanation of the data types</a> is included
+ * This documentation mentions data types for some arguments. An <a
href="data_types.html">explanation of the data types</a> is included
* in this documentation package.
* </p>
*/
diff --git
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
index d790203e..2f883d6e 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
@@ -61,7 +61,7 @@ import org.codehaus.plexus.util.ReaderFactory;
import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
/**
- * Generates a report with Rat's output.
+ * Generates a report with RAT's output.
*/
@Mojo(name = "rat", requiresDependencyResolution = ResolutionScope.TEST,
threadSafe = true)
public class RatReportMojo extends AbstractRatMojo implements
MavenMultiPageReport {
diff --git a/apache-rat-plugin/src/site/apt/examples/custom-license.apt.vm
b/apache-rat-plugin/src/site/apt/examples/custom-license.apt.vm
index 710e0d32..59de22aa 100644
--- a/apache-rat-plugin/src/site/apt/examples/custom-license.apt.vm
+++ b/apache-rat-plugin/src/site/apt/examples/custom-license.apt.vm
@@ -37,7 +37,7 @@ Custom License Matchers
The easiest solution for defining custom licenses is to use the <<<config>>>
option. For this option write your custom configuration like you would for the
command line and then include it. In the example below the custom configuration
is called <<<myConfig.xml>>>
- ------------------------------------------------------------------
+------------------------------------------------------------------
<build>
<plugins>
...
diff --git a/apache-rat-plugin/src/site/site.xml
b/apache-rat-plugin/src/site/site.xml
index 215cafc4..26e43efe 100644
--- a/apache-rat-plugin/src/site/site.xml
+++ b/apache-rat-plugin/src/site/site.xml
@@ -1,4 +1,4 @@
-<?xml version='1.0'?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,16 +15,10 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/DECORATION/1.3.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0
http://maven.apache.org/xsd/decoration-1.3.0.xsd";
- name="Apache Rat™ Plugin for Apache Maven">
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT™ Plugin
for Apache Maven">
<body>
- <head>
- <![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]>
- </head>
-
+ <head><![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]></head>
<menu ref="parent"/>
-
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
@@ -38,7 +32,6 @@
<item name="Adding a report to the site" href="examples/site.html"/>
<item name="Custom license" href="examples/custom-license.html"/>
</menu>
-
<menu ref="reports"/>
</body>
-</project>
+</site>
diff --git a/apache-rat-tasks/run-antunit.xml b/apache-rat-tasks/run-antunit.xml
index b60c6ec0..c81fbf61 100644
--- a/apache-rat-tasks/run-antunit.xml
+++ b/apache-rat-tasks/run-antunit.xml
@@ -19,7 +19,7 @@
under the License. *
-->
-<project name="AntUnit Tests for Rat Ant Tasks"
+<project name="AntUnit Tests for RAT Ant Tasks"
default="antunit">
<property name="jar.name" location="target/classes"/>
diff --git a/apache-rat-tasks/src/site/apt/examples/basic.apt.vm
b/apache-rat-tasks/src/site/apt/examples/basic.apt.vm
index 81be1019..630ad280 100644
--- a/apache-rat-tasks/src/site/apt/examples/basic.apt.vm
+++ b/apache-rat-tasks/src/site/apt/examples/basic.apt.vm
@@ -21,11 +21,11 @@
Examples
- These examples assume you have installed the Rat Antlib in a way
+ These examples assume you have installed the RAT Antlib in a way
that provides the Report task in the XML namespace associated with
the prefix <<<rat>>>.
-* Run Rat in default configuration on all files in directory <<<src>>>.
+* Run RAT in default configuration on all files in directory <<<src>>>.
---
<rat:report>
@@ -44,7 +44,7 @@ java -jar apache-rat-${project.version}.jar src
except that Ant's default excludes will be applied when looking for
documents to check.
-* Run Rat on multiple directories
+* Run RAT on multiple directories
---
<rat:report>
@@ -76,7 +76,7 @@ java -jar apache-rat-${project.version}.jar --edit-license
There are two types of styled reports, both are activated by using the
"outputStyled" attribute on the "rat:report" element.
- The first is the standard report type. This uses one of the standard reports
shipped with Rat which are activated by setting the value of "outputStyled" to
the name of the report.
+ The first is the standard report type. This uses one of the standard reports
shipped with RAT which are activated by setting the value of "outputStyled" to
the name of the report.
* plain-rat: The default style.
@@ -94,7 +94,7 @@ java -jar apache-rat-${project.version}.jar --edit-license
</rat:report>
---
- The second type is the user defined XSLT. In this case the user provides the
path to the xslt document as shown below. There is a report XSD and the
standard report XSLT files are listed in the Rat Output documentation. In the
example below the user has provided a "rat-xml-2-html.xslt" transformation and
the output will be written to "rat.html"
+ The second type is the user defined XSLT. In this case the user provides the
path to the xslt document as shown below. There is a report XSD and the
standard report XSLT files are listed in the RAT Output documentation. In the
example below the user has provided a "rat-xml-2-html.xslt" transformation and
the output will be written to "rat.html"
---
<rat:report outputStyle="my/rat-xml-2-html.xslt" outputFile="rat.html">
@@ -102,7 +102,7 @@ java -jar apache-rat-${project.version}.jar --edit-license
</rat:report>
---
-* Run Rat on a tarball located on a webserver
+* Run RAT on a tarball located on a webserver
---
<rat:report>
@@ -114,7 +114,7 @@ java -jar apache-rat-${project.version}.jar --edit-license
</rat:report>
---
-* Run Rat but make the Apache License Version 2.0 the only one
+* Run RAT but make the Apache License Version 2.0 the only one
accepted
---
@@ -124,7 +124,7 @@ java -jar apache-rat-${project.version}.jar --edit-license
</rat:report>
---
-* Run Rat on all files in <<<src>>> that have been modified today
+* Run RAT on all files in <<<src>>> that have been modified today
---
<tstamp/>
@@ -136,7 +136,7 @@ java -jar apache-rat-${project.version}.jar --edit-license
</rat:report>
---
-* Make Rat only detect your custom license and mark this license
+* Make RAT only detect your custom license and mark this license
approved.
Create a configuration file containing only your definition(s).
diff --git a/apache-rat-tasks/src/site/apt/examples/report.apt
b/apache-rat-tasks/src/site/apt/examples/report.apt
index 93cc8ebe..32c295d6 100644
--- a/apache-rat-tasks/src/site/apt/examples/report.apt
+++ b/apache-rat-tasks/src/site/apt/examples/report.apt
@@ -21,8 +21,8 @@
Report Task
- The Report task is the heart of the Apache Rat Ant Task Library, it
- runs Rat on a given set of resources and generates the report.
+ The Report task is the heart of the Apache RAT Ant Task Library, it
+ runs RAT on a given set of resources and generates the report.
The task can work on any Ant
{{{https://ant.apache.org/manual/Types/resources.html}resource or
@@ -33,7 +33,7 @@ Report Task
by a custom XSLT stylesheet.
It is possible to define custom matchers for licenses not directly supported
- by Rat via nested elements to the Report task.
+ by RAT via nested elements to the Report task.
* Report Task Attributes
diff --git a/apache-rat-tasks/src/site/site.xml
b/apache-rat-tasks/src/site/site.xml
index 48caaff8..222b051d 100644
--- a/apache-rat-tasks/src/site/site.xml
+++ b/apache-rat-tasks/src/site/site.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" ?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,16 +15,10 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/DECORATION/1.3.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0
http://maven.apache.org/xsd/decoration-1.3.0.xsd";
- name="Apache Rat™ Task Library for Apache Ant">
- <body>
- <head>
- <![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]>
- </head>
-
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT\u2122 Task
Library for Apache Ant">
+ <body>
+ <head><![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]></head>
<menu ref="parent"/>
-
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Report Task" href="report.html"/>
@@ -32,7 +26,6 @@
<menu name="Examples">
<item name="Basic Usage" href="examples/basic.html"/>
</menu>
-
<menu ref="reports"/>
</body>
-</project>
+</site>
diff --git a/apache-rat-tasks/src/templates/apt/index.apt.vm.vm
b/apache-rat-tasks/src/templates/apt/index.apt.vm.vm
index f44026de..2be95c04 100644
--- a/apache-rat-tasks/src/templates/apt/index.apt.vm.vm
+++ b/apache-rat-tasks/src/templates/apt/index.apt.vm.vm
@@ -53,7 +53,7 @@ Apache RAT Ant Task Library
works well with 1.8.x), Apache RAT core and transitively all
dependencies of Apache RAT core.
- In order to use the tasks Java 5 is required as of RAT 0.9 - Rat 0.8
+ In order to use the tasks Java 5 is required as of RAT 0.9 - RAT 0.8
and earlier require Java 1.4.
Java 8 is required for RAT 0.14 and above.
diff --git a/apache-rat-tasks/src/test/resources/antunit/report-junit.xml
b/apache-rat-tasks/src/test/resources/antunit/report-junit.xml
index 4f6dbf55..81827d40 100644
--- a/apache-rat-tasks/src/test/resources/antunit/report-junit.xml
+++ b/apache-rat-tasks/src/test/resources/antunit/report-junit.xml
@@ -527,8 +527,5 @@ public class InlineMatcher extends AbstractHeaderMatcher {
<rat:report helpLicenses='true' />
</target>
-
-
<!-- Process finished with exit code 0 -->
-
</project>
diff --git
a/apache-rat-tasks/src/test/resources/antunit/report-normal-operation.xml
b/apache-rat-tasks/src/test/resources/antunit/report-normal-operation.xml
index 8cbea17e..227ad7ce 100644
--- a/apache-rat-tasks/src/test/resources/antunit/report-normal-operation.xml
+++ b/apache-rat-tasks/src/test/resources/antunit/report-normal-operation.xml
@@ -127,8 +127,8 @@ SPDX-License-Identifier: Apache-2.0
<rat:license
family="YASL1"
notes="Interesting License">
- <!-- non existant copyright in this file -->
- <rat:copyright owner="non existant" />
+ <!-- non existent copyright in this file -->
+ <rat:copyright owner="non existent" />
</rat:license>
</rat:report>
</target>
@@ -142,8 +142,8 @@ SPDX-License-Identifier: Apache-2.0
<rat:license
family="YASL1"
notes="Interesting License">
- <!-- non existant copyright in this
file -->
- <rat:copyright owner="non existant" />
+ <!-- non existent copyright in this
file -->
+ <rat:copyright owner="non existent" />
</rat:license>
</rat:report>
<copy overwrite="true" file="${report.file}"
toFile="${reports.dir}/TEST-testWithALUnknownSentToFile.out"/>
@@ -224,8 +224,8 @@ SPDX-License-Identifier: Apache-2.0
family="YASL1"
notes="Interesting License">
<rat:not>
- <!-- non existant copyright
in this file -->
- <rat:copyright owner="non
existant" />
+ <!-- non existent copyright
in this file -->
+ <rat:copyright owner="non
existent" />
</rat:not>
</rat:license>
</rat:report>
@@ -348,8 +348,8 @@ SPDX-License-Identifier: Apache-2.0
<rat:license
family="YASL1"
notes="Interesting License">
- <!-- non existant copyright in this
file -->
- <rat:copyright owner="non existant" />
+ <!-- non existent copyright in this
file -->
+ <rat:copyright owner="non existent" />
</rat:license>
</rat:report>
<copy overwrite="true" file="${report.file}"
toFile="${reports.dir}/TEST-testNoLicenseMatchSentToFile.out"/>
diff --git a/apache-rat-tasks/src/test/resources/antunit/report-options.xml
b/apache-rat-tasks/src/test/resources/antunit/report-options.xml
index 984513b6..e94e9bb4 100644
--- a/apache-rat-tasks/src/test/resources/antunit/report-options.xml
+++ b/apache-rat-tasks/src/test/resources/antunit/report-options.xml
@@ -38,7 +38,6 @@
</path>
</pathconvert>
-
<target name="testOption">
<rat:report>
${option}
diff --git a/apache-rat-tools/src/site/apt/index.apt.vm
b/apache-rat-tools/src/site/apt/index.apt.vm
index 1d06f8fd..cf59cb47 100644
--- a/apache-rat-tools/src/site/apt/index.apt.vm
+++ b/apache-rat-tools/src/site/apt/index.apt.vm
@@ -19,7 +19,7 @@
Introduction
-----
-Apache Rat Tools
+Apache RAT Tools
The tools project contains code generators and tooling to write configuration
data for:
@@ -29,4 +29,4 @@ Apache Rat Tools
* XSD file generation
- * available configuration options or arguments and their documentation for Rat
+ * available configuration options or arguments and their documentation for RAT
diff --git a/apache-rat-tools/src/site/site.xml
b/apache-rat-tools/src/site/site.xml
index 6a92692e..de3292da 100644
--- a/apache-rat-tools/src/site/site.xml
+++ b/apache-rat-tools/src/site/site.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" ?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,20 +15,13 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/DECORATION/1.3.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0
http://maven.apache.org/xsd/decoration-1.3.0.xsd";
- name="Apache Rat™ Tools">
- <body>
- <head>
- <![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]>
- </head>
-
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT™ Tools">
+ <body>
+ <head><![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]></head>
<menu ref="parent"/>
-
<menu name="Overview">
<item name="Introduction" href="index.html"/>
</menu>
-
<menu ref="reports"/>
</body>
-</project>
+</site>
diff --git a/apache-rat/README-ANT.txt b/apache-rat/README-ANT.txt
index 0effdc95..59b8e334 100644
--- a/apache-rat/README-ANT.txt
+++ b/apache-rat/README-ANT.txt
@@ -1,4 +1,4 @@
-Apache Rat Ant Task Library
+Apache RAT Ant Task Library
===========================
The Ant Task Library provides a single Ant task and a few supporting Ant types
to run Rat,
@@ -10,7 +10,7 @@ or even URLs directly.
Requirements
------------
-The Rat Ant Task Library requires Apache Ant 1.7.1 or higher (it works well
with 1.8.x)
+The RAT Ant Task Library requires Apache Ant 1.7.1 or higher (it works well
with 1.8.x)
Installation
------------
diff --git a/apache-rat/README-CLI.txt b/apache-rat/README-CLI.txt
index 0e1a4d9a..1b1261c0 100644
--- a/apache-rat/README-CLI.txt
+++ b/apache-rat/README-CLI.txt
@@ -1,7 +1,7 @@
-About Apache Rat™
+About Apache RAT™
================
-Rat audits software distributions, with a special interest in headers.
+RAT audits software distributions, with a special interest in headers.
If this isn't quite what you're looking for then take a look at the
other products developed by Apache Creadur™,
including Apache Whisker™ which audits and generates legal (for example
LICENSE)
@@ -19,8 +19,8 @@ This will output a help message detailing the command line
options available to
Adding license headers
----------------------
-Rat can be used to automatically add license headers to files that do not
currently have them.
-Only files that are not excluded by the Rat configurations will be affected.
+RAT can be used to automatically add license headers to files that do not
currently have them.
+Only files that are not excluded by the RAT configurations will be affected.
To add license headers use a command such as:
@@ -32,9 +32,9 @@ This command will add the license header directly to the
source files.
If you prefer to see which files will be changed and how then remove the
"--force" option.
Using multiple excludes from a file
-It is common to use the Rat with the maven or ant plugins and specify a series
of files to exclude
+It is common to use the RAT with the maven or ant plugins and specify a series
of files to exclude
(such as a README or version control files).
-If you are using the Rat application instead of a plugin you can specify a
series of regex excludes
+If you are using the RAT application instead of a plugin you can specify a
series of regex excludes
in a file and specify that with the -E option.
java -jar apache-rat-${project.version}.jar
diff --git a/apache-rat/src/site/apt/name_xref.apt.vm
b/apache-rat/src/site/apt/name_xref.apt.vm
index 5a821542..b0b9940d 100644
--- a/apache-rat/src/site/apt/name_xref.apt.vm
+++ b/apache-rat/src/site/apt/name_xref.apt.vm
@@ -15,9 +15,11 @@
~~ limitations under the License.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ---------------
+ ----------------
Option Overview
- ---------------
+ ----------------
+
+Option Overview
The following lists the options that are available in all clients.
diff --git a/apache-rat/src/site/apt/xsd.apt.vm
b/apache-rat/src/site/apt/xsd.apt.vm
index adb1471d..9770064d 100644
--- a/apache-rat/src/site/apt/xsd.apt.vm
+++ b/apache-rat/src/site/apt/xsd.apt.vm
@@ -15,12 +15,14 @@
~~ limitations under the License.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ------------------------------------
- Configuration XML Schema Definition
- ------------------------------------
+ -----------------------------------
+ Configuration XML Schema Definition
+ -----------------------------------
- There is a standard {{{./rat.xsd}Rat XSD file}} that describes the
configuration file options and can be used to verify
- any configuration file that only depends on the matchers shipped with Rat.
+Configuration XML Schema Definition
+
+ There is a standard {{{./rat.xsd}RAT XSD file}} that describes the
configuration file options and can be used to verify
+ any configuration file that only depends on the matchers shipped with RAT.
If new matchers are implemented and properly documented the system can
generate the XSD for it as well. To generate
a XSD execute the following:
@@ -29,5 +31,5 @@
java -jar apache-rat/target/apache-rat-${project.version}.jar
org.apache.rat.tools.xsd.XsdGenerator [options]
+------------------------------------------+
- Where '[options]' are the options used to add the new definitions to Rat.
Specifically these will include configurations
+ Where '[options]' are the options used to add the new definitions to RAT.
Specifically these will include configurations
that define new matchers.
diff --git a/apache-rat/src/site/resources/site/index.md.vm
b/apache-rat/src/site/resources/site/index.md.vm
index d0f607e8..6b761598 100644
--- a/apache-rat/src/site/resources/site/index.md.vm
+++ b/apache-rat/src/site/resources/site/index.md.vm
@@ -17,7 +17,7 @@
${esc.hash} Command Line Support
#set($doublespace = ${esc.newLine}+${esc.newline})
- ${esc.hash}${esc.hash} About Apache Rat™
+ ${esc.hash}${esc.hash} About Apache RAT™
RAT audits software distributions, with a special interest in headers.
If this isn't quite what you're looking for then take a look at the
diff --git a/apache-rat/src/site/site.xml b/apache-rat/src/site/site.xml
index 310ce798..862aa63d 100644
--- a/apache-rat/src/site/site.xml
+++ b/apache-rat/src/site/site.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" ?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,15 +15,10 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/DECORATION/1.3.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0
http://maven.apache.org/xsd/decoration-1.3.0.xsd";
- name="Apache Rat™">
- <body>
- <head>
- <![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]>
- </head>
-
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT™">
+ <body>
+ <head><![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]></head>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
-</project>
+</site>
diff --git a/apache-rat/src/templates/apt/default_licenses.apt.vm
b/apache-rat/src/templates/apt/default_licenses.apt.vm
index 0504a279..5e71975c 100644
--- a/apache-rat/src/templates/apt/default_licenses.apt.vm
+++ b/apache-rat/src/templates/apt/default_licenses.apt.vm
@@ -20,7 +20,9 @@
Default Licenses and Matchers
------------------------------
-The following lists the Licenses, and Matchers that are available by default.
+Default Licenses and Matchers
+
+ The following lists the Licenses, and Matchers that are available by default.
* License Properties
diff --git a/pom.xml b/pom.xml
index 83d72e2d..72f02b57 100644
--- a/pom.xml
+++ b/pom.xml
@@ -62,7 +62,7 @@ agnostic home for software distribution comprehension and
audit tools.
<!-- maven plugin versions -->
<mavenPluginTestingVersion>3.3.0</mavenPluginTestingVersion>
<mavenPluginPluginVersion>3.15.1</mavenPluginPluginVersion>
- <mavenChangesVersion>2.12.1</mavenChangesVersion>
+ <mavenChangesVersion>3.0.0-M1</mavenChangesVersion>
<mavenJavadocPluginVersion>3.11.2</mavenJavadocPluginVersion>
<mavenPmdPluginVersion>3.27.0</mavenPmdPluginVersion>
<!-- Used to generate download page for RAT during site builds, please
adapt versions manually BEFORE doing a release -->
@@ -82,6 +82,12 @@ agnostic home for software distribution comprehension and
audit tools.
</distributionManagement>
<dependencyManagement>
<dependencies>
+ <!-- used to render the site and make skin updates more transparent -->
+ <dependency>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>2.0.1</version>
+ </dependency>
<dependency>
<groupId>org.apache.rat</groupId>
<artifactId>apache-rat-core</artifactId>
@@ -262,8 +268,6 @@ agnostic home for software distribution comprehension and
audit tools.
<statusIds>Resolved,Closed</statusIds>
<!-- Don't include sub-task -->
<typeIds>Bug,New Feature,Task,Improvement,Wish,Test</typeIds>
- <!-- For JIRA >= 5.1 -->
- <useJql>true</useJql>
<!-- TODO: what's the meaning of these copy-paste variables? -->
<onlyCurrentVersion>${commons.changes.onlyCurrentVersion}</onlyCurrentVersion>
<maxEntries>${commons.changes.maxEntries}</maxEntries>
@@ -274,12 +278,70 @@ agnostic home for software distribution comprehension and
audit tools.
<reportSets>
<reportSet>
<reports>
- <report>changes-report</report>
- <report>jira-report</report>
+ <report>changes</report>
+ <report>jira-changes</report>
+ <report>github-changes</report>
</reports>
</reportSet>
</reportSets>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changelog-plugin</artifactId>
+ <version>2.3</version>
+ </plugin>
+ <!-- catch code tags -->
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>taglist-maven-plugin</artifactId>
+ <version>3.2.1</version>
+ <configuration>
+ <tagListOptions>
+ <tagClasses>
+ <tagClass>
+ <displayName>Todo Work</displayName>
+ <tags>
+ <tag>
+ <matchString>todo</matchString>
+ <matchType>ignoreCase</matchType>
+ </tag>
+ <tag>
+ <matchString>fixme</matchString>
+ <matchType>ignoreCase</matchType>
+ </tag>
+ </tags>
+ </tagClass>
+ <tagClass>
+ <displayName>Refactor Work</displayName>
+ <tags>
+ <tag>
+ <matchString>refactor</matchString>
+ <matchType>ignoreCase</matchType>
+ </tag>
+ </tags>
+ </tagClass>
+ <tagClass>
+ <displayName>Review Work</displayName>
+ <tags>
+ <tag>
+ <matchString>review</matchString>
+ <matchType>ignoreCase</matchType>
+ </tag>
+ </tags>
+ </tagClass>
+ <tagClass>
+ <displayName>Deprecated items</displayName>
+ <tags>
+ <tag>
+ <matchString>@deprecated</matchString>
+ <matchType>ignoreCase</matchType>
+ </tag>
+ </tags>
+ </tagClass>
+ </tagClasses>
+ </tagListOptions>
+ </configuration>
+ </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
@@ -355,7 +417,7 @@ agnostic home for software distribution comprehension and
audit tools.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
- <version>3.6.2</version>
+ <version>3.9.0</version>
<reportSets>
<reportSet>
<reports>
@@ -480,10 +542,7 @@ agnostic home for software distribution comprehension and
audit tools.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
- <version>3.12.1</version>
- <configuration>
- <relativizeDecorationLinks>false</relativizeDecorationLinks>
- </configuration>
+ <version>3.21.0</version>
</plugin>
<plugin>
<groupId>org.apache.rat</groupId>
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index a1f15383..a8d59795 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -72,6 +72,12 @@ The <action> type attribute can be one of:
</release>
-->
<release version="0.17-SNAPSHOT" date="xxxx-yy-zz" description="Current
SNAPSHOT - release to be done">
+ <action issue="RAT-444" type="fix" dev="pottlinger">
+ Fix missing headlines when site templates are handled/filtered by
Velocity.
+ </action>
+ <action issue="RAT-397" type="add" dev="pottlinger">
+ Migrate webpage to newer site-plugin stack and change skin of site.
Removed some of the reports as plugins are discontinued. Rename to RAT
consistently.
+ </action>
<action issue="RAT-473" type="add" dev="engelen">
Take global gitignore into account when determining which files to
audit and which to skip.
</action>
diff --git a/src/changes/release-notes.vm b/src/changes/release-notes.vm
index a008aee1..93575fa2 100644
--- a/src/changes/release-notes.vm
+++ b/src/changes/release-notes.vm
@@ -114,7 +114,7 @@ Removed:
## End of main loop
#end
-Historical list of changes: ${project.url}changes-report.html
+Historical list of changes: ${project.url}changes.html
For complete information on ${project.name}, including instructions on how to
submit bug reports,
patches, or suggestions for improvement, see the Apache ${project.name}
website:
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 068ee695..55f87c85 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -41,7 +41,7 @@ A Release Audit Tool (RAT)
Apache RAT™
- In a hurry? Jump to {{{Quick_Start:_Running_Rat}quick start}}
+ In a hurry? Jump to {{{Quick_Start:_Running_RAT}quick start}}
%{toc|fromDepth=2|toDepth=3}
diff --git a/src/site/markdown/development/ui/generator.md
b/src/site/markdown/development/ui/generator.md
index 07c81dfe..195aa231 100644
--- a/src/site/markdown/development/ui/generator.md
+++ b/src/site/markdown/development/ui/generator.md
@@ -101,7 +101,7 @@ import java.util.stream.Collectors;
/* DO NOT EDIT - GENERATED FILE */
/**
- * Generated class to provide Maven support for standard Rat command line
options
+ * Generated class to provide Maven support for standard RAT command line
options
*/
${class}
diff --git a/src/site/site.xml b/src/site/site.xml
index df5e7627..aa7917df 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" ?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,74 +15,71 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/DECORATION/1.3.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xsi:schemaLocation="https://maven.apache.org/DECORATION/1.3.0
https://maven.apache.org/xsd/decoration-1.3.0.xsd";
- name="Apache Rat&trade;">
- <bannerLeft>
- <title>The Apache Software Foundation</title>
- <name>The Apache Software Foundation</name>
- <src>https://www.apache.org/img/asf_logo.png</src>
- <href>https://www.apache.org/</href>
+<site xmlns="http://maven.apache.org/SITE/2.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0
https://maven.apache.org/xsd/site-2.0.0.xsd"; name="Apache RAT™ - A
Release Audit Tool">
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <!-- version is managed in pom.xml in order to be grabbed by dependabot -->
+ </skin>
+ <custom>
+ <fluidoSkin>
+ <gitHub>
+ <projectId>apache/creadur-rat</projectId>
+ <ribbonOrientation>right</ribbonOrientation>
+ <ribbonColor>blue</ribbonColor>
+ </gitHub>
+ </fluidoSkin>
+ </custom>
+ <bannerLeft name="Apache RAT" href="https://www.apache.org/";>
+ <image src="https://www.apache.org/img/asf_logo.png"; alt="The Apache
Software Foundation"/>
</bannerLeft>
-
<poweredBy>
- <logo name="Maven"
- href="https://maven.apache.org/";
- img="https://maven.apache.org/images/logos/maven-feather.png"/>
+ <logo name="Maven" href="https://maven.apache.org/";>
+ <image src="https://maven.apache.org/images/logos/maven-feather.png"/>
+ </logo>
</poweredBy>
-
<body>
- <head>
- <![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]>
- </head>
-
+ <head><![CDATA[<link href="https://creadur.apache.org/font/matesc.css";
type="text/css" rel="stylesheet" />]]></head>
<breadcrumbs>
<item name="Apache" href="https://www.apache.org/"/>
<item name="Creadur" href="https://creadur.apache.org/"/>
<item name="RAT" href="https://creadur.apache.org/rat/"/>
</breadcrumbs>
-
- <menu name="Apache RAT™" inherit="bottom">
+ <menu name="Apache RAT™" inherit="bottom">
<item name="Introducing RAT" href="/index.html"/>
<item name="Downloads" href="/download_rat.cgi"/>
- <item name="Changes" href="/changes-report.html"/>
+ <item name="Changes" href="/changes.html"/>
</menu>
-
<menu name="RAT from the Command Line" inherit="bottom">
<item name="Command Line Introduction" href="apache-rat/index.html"/>
<item name="Command Line Options" href="apache-rat/cli_options.html"/>
<item name="Exclusion Expressions"
href="apache-rat-core/exclusion_expression.html"/>
<item name="Standard Collections"
href="apache-rat/standard_collections.html"/>
</menu>
-
<menu name="RAT from Ant" inherit="bottom">
<item name="Ant Task Introduction" href="apache-rat-tasks/index.html"/>
<item name="Ant Elements and Attributes"
href="apache-rat-tasks/ant_options.html"/>
</menu>
-
<menu name="RAT from Maven" inherit="bottom">
<item name="Maven Plugin Introduction"
href="apache-rat-plugin/index.html"/>
<item name="Maven Options" href="apache-rat-plugin/mvn_options.html"/>
<item name="Maven Examples"
href="apache-rat-plugin/examples/index.html"/>
</menu>
-
<menu name="Configuring RAT" inherit="bottom">
- <item name="Option Name Cross Reference"
href="apache-rat/name_xref.html" />
- <item name="Default Licenses" href="apache-rat/default_licenses.html" />
- <item name="Default Matchers" href="apache-rat/default_matchers.html" />
+ <item name="Option Name Cross Reference"
href="apache-rat/name_xref.html"/>
+ <item name="Default Licenses" href="apache-rat/default_licenses.html"/>
+ <item name="Default Matchers" href="apache-rat/default_matchers.html"/>
<item name="Defining New Licenses" href="license_def.html"/>
- <item name="Configuration XSD" href="apache-rat/xsd.html" />
- <item name="Default Configuration"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml";
/>
+ <item name="Configuration XSD" href="apache-rat/xsd.html"/>
+ <item name="Default Configuration"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml"/>
</menu>
-
<menu name="RAT Output" inherit="bottom">
<item name="Standard Output Example"
href="apache-rat/output/example.html"/>
- <item name="Output XSD"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/rat-report.xsd";
/>
- <item name ="XSLT - Plain text"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl";
/>
- <item name ="XSLT - Missing headers list"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl";
/>
- <item name ="XSLT - Unapproved licenses list"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl";
/>
+ <item name="Output XSD"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/rat-report.xsd"/>
+ <item name="XSLT - Plain text"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl"/>
+ <item name="XSLT - Missing headers list"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl"/>
+ <item name="XSLT - Unapproved licenses list"
href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl"/>
</menu>
-
<menu name="Developing RAT" inherit="bottom">
<item name="Architecture" href="architecture.html"/>
<item name="Javadocs" href="/apidocs/index.html"/>
@@ -90,54 +87,42 @@
<item name="UI Development" href="development/ui_implementation.html"/>
<item name="Writing a File Processor"
href="apache-rat-core/development/write_file_processor.html"/>
</menu>
-
- <menu name="Apache Creadur™" inherit="bottom">
- <item name='Creadur Project Home' href="https://creadur.apache.org"/>
- <item name='Apache Tentacles'
href="https://creadur.apache.org/tentacles"/>
- <item name='Apache Whisker' href="https://creadur.apache.org/whisker"/>
- <item name='Security' href='https://www.apache.org/security/'/>
- <item name='License' href='https://www.apache.org/licenses/'/>
- <item name='Privacy'
href='https://privacy.apache.org/policies/privacy-policy-public.html'/>
- <item name='Sponsorship'
href='https://www.apache.org/foundation/sponsorship.html'/>
- <item name='Thanks'
href='https://www.apache.org/foundation/thanks.html'/>
+ <menu name="Apache Creadur™" inherit="bottom">
+ <item name="Creadur Project Home" href="https://creadur.apache.org"/>
+ <item name="Apache Tentacles"
href="https://creadur.apache.org/tentacles"/>
+ <item name="Apache Whisker" href="https://creadur.apache.org/whisker"/>
+ <item name="Security" href="https://www.apache.org/security/"/>
+ <item name="License" href="https://www.apache.org/licenses/"/>
+ <item name="Privacy"
href="https://privacy.apache.org/policies/privacy-policy-public.html"/>
+ <item name="Sponsorship"
href="https://www.apache.org/foundation/sponsorship.html"/>
+ <item name="Thanks"
href="https://www.apache.org/foundation/thanks.html"/>
</menu>
-
<menu name="The Apache Software Foundation" inherit="bottom">
- <item name='About the Foundation'
- href="https://www.apache.org/foundation"/>
- <item name='The projects'
- href="https://projects.apache.org"/>
- <item name='The people'
- href="https://people.apache.org"/>
- <item name='How we work'
- href='https://www.apache.org/foundation/how-it-works.html'/>
- <item name='Our history'
-
href='https://www.apache.org/foundation/how-it-works.html#history'/>
- <item name='News'
- href='https://blogs.apache.org/foundation/'/>
+ <item name="About the Foundation"
href="https://www.apache.org/foundation"/>
+ <item name="The projects" href="https://projects.apache.org"/>
+ <item name="The people" href="https://people.apache.org"/>
+ <item name="How we work"
href="https://www.apache.org/foundation/how-it-works.html"/>
+ <item name="Our history"
href="https://www.apache.org/foundation/how-it-works.html#history"/>
+ <item name="News" href="https://blogs.apache.org/foundation/"/>
</menu>
-
<menu name="Contribute" inherit="bottom">
- <item name="Get Involved"
href='https://www.apache.org/foundation/getinvolved.html'/>
+ <item name="Get Involved"
href="https://www.apache.org/foundation/getinvolved.html"/>
</menu>
-
<menu name="Committer Info" inherit="bottom">
- <item name="ASF Committers' FAQ"
href='https://www.apache.org/dev/committers.html'/>
- <item name='New Committers Guide'
href='https://www.apache.org/dev/new-committers-guide.html'/>
+ <item name="ASF Committers' FAQ"
href="https://www.apache.org/dev/committers.html"/>
+ <item name="New Committers Guide"
href="https://www.apache.org/dev/new-committers-guide.html"/>
<item name="How to publish this site"
href="https://gitbox.apache.org/repos/asf/creadur-site/blob/asf-site/README.md"/>
- <item name='Community' href='https://community.apache.org/'/>
- <item name='Legal' href='https://www.apache.org/legal/'/>
- <item name='Branding' href='https://www.apache.org/foundation/marks/'/>
- <item name='Media Relations' href='https://www.apache.org/press/'/>
+ <item name="Community" href="https://community.apache.org/"/>
+ <item name="Legal" href="https://www.apache.org/legal/"/>
+ <item name="Branding" href="https://www.apache.org/foundation/marks/"/>
+ <item name="Media Relations" href="https://www.apache.org/press/"/>
</menu>
-
<menu ref="modules"/>
<menu ref="reports"/>
-
<footer>Copyright &copy; 2016-2025 The Apache Software Foundation,
Licensed under the Apache License, Version 2.0.
Apache Creadur, Creadur, Apache RAT, Apache Tentacles, Apache Whisker,
Apache and the Apache feather logo are trademarks
of The Apache Software Foundation.
Oracle and Java are registered trademarks of Oracle and/or its
affiliates.
All other marks mentioned may be trademarks or registered trademarks of
their respective owners.</footer>
</body>
-</project>
+</site>
![https://www.apache.org/img/asf_logo.png"](https://www.apache.org/img/asf_logo.png"){kind=link}
![https://maven.apache.org/images/logos/maven-feather.png"/](https://maven.apache.org/images/logos/maven-feather.png"/){kind=link}