Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: RAT-397: Migrate RAT to new site stack and prepare for upcoming Doxia 2.x migration #386

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
920306f
RAT-397: Allowe deployment of site next to old version in rat017
ottlinger Nov 7, 2024
2aee606
RAT-397: Start migration to new site/skin structure
ottlinger Nov 7, 2024
b8a459a
RAT-397, RAT-345: Update project-info-reports-plugin
ottlinger Nov 8, 2024
cf051c0
RAT-397: Migrate base site structures
ottlinger Nov 8, 2024
c1bcb40
RAT-397: Add github ribbon
ottlinger Nov 15, 2024
ccd7caa
RAT-397: xmllint site desc
ottlinger Nov 15, 2024
c5886a8
RAT-397: Add build helper to format site descriptors properly
ottlinger Nov 15, 2024
c872260
RAT-397: Cleanup all site descriptors
ottlinger Nov 15, 2024
363500d
RAT-397: Fix coordinates
ottlinger Nov 15, 2024
cc7aa78
Merge remote-tracking branch 'origin/master' into feature/RAT-397
ottlinger Nov 23, 2024
7062ee7
RAT-379: Resources from the parent project are no longer handled by t…
jochenw Dec 2, 2024
4e76340
Revert "RAT-379: Resources from the parent project are no longer hand…
ottlinger Dec 2, 2024
ee34979
RAT-379: Resources from the parent project are no longer handled by t…
jochenw Dec 2, 2024
cc0d20a
Restoring the ability to build with Maven 4
jochenw Dec 2, 2024
a91c209
Revert "Restoring the ability to build with Maven 4"
ottlinger Dec 2, 2024
27bed36
Revert "RAT-379: Resources from the parent project are no longer hand…
ottlinger Dec 2, 2024
6b7ee32
Merge remote-tracking branch 'origin/master' into feature/RAT-397
ottlinger Dec 5, 2024
d6d6339
MCHANGELOG-157, RAT-397: Add other broken report
ottlinger Dec 5, 2024
05d6f11
RAT-397: Adapt target to new changes version
ottlinger Dec 12, 2024
bdc3975
Merge branch 'master' into feature/RAT-397
ottlinger Dec 12, 2024
b47955d
RAT-397: Remove deprecated configuration params
ottlinger Dec 12, 2024
6ba119a
Merge remote-tracking branch 'origin/master' into feature/RAT-397
ottlinger Dec 12, 2024
d6dd171
RAT-397: explicitly manage version of skin used
ottlinger Dec 12, 2024
8115815
Merge remote-tracking branch 'origin/master' into feature/RAT-397
ottlinger Dec 13, 2024
21c56af
RAT-397: Adapt changelog configs
ottlinger Dec 13, 2024
4fc0292
RAT-397: Add taglist plugin
ottlinger Dec 13, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .buildtools/formatSiteXml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 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.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
for siteDesc in `find . -name \site.xml`
do
xmllint --format $siteDesc > /tmp/w
mv /tmp/w $siteDesc
done
4 changes: 2 additions & 2 deletions .buildtools/generateStagingSiteInWebpageRepo
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@
# DEVHINT: RAT-302: Do not use modern JDK due to the javadoc problem; JDK8 and 16 are okay
# DEVHINT: package build is required as site target requires access to the completed jar package.
./mvnw clean package site site:stage
cp -rvf target/staging/* ../creadur-site/rat017/
cp -rvf src/site/javadocFont/* ../creadur-site/rat017/apidocs/
cp -rvf target/staging/* ../creadur-site/RAT-397/
cp -rvf src/site/javadocFont/* ../creadur-site/RAT-397/apidocs/
15 changes: 5 additions & 10 deletions apache-rat-core/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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&trade; 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&#x2122; 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>
15 changes: 4 additions & 11 deletions apache-rat-plugin/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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&trade; 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&#x2122; 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"/>
Expand All @@ -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>
17 changes: 5 additions & 12 deletions apache-rat-tasks/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -15,24 +15,17 @@
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&trade; 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"/>
</menu>
<menu name="Examples">
<item name="Basic Usage" href="examples/basic.html"/>
</menu>

<menu ref="reports"/>
</body>
</project>
</site>
17 changes: 5 additions & 12 deletions apache-rat-tools/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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&trade; 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&#x2122; 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>
15 changes: 5 additions & 10 deletions apache-rat/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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&trade;">
<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&#x2122;">
<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>
79 changes: 69 additions & 10 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ agnostic home for software distribution comprehension and audit tools.
<creadur.jira.id>RAT</creadur.jira.id>
<!-- maven plugin versions -->
<mavenPluginPluginVersion>3.15.1</mavenPluginPluginVersion>
<mavenChangesVersion>2.12.1</mavenChangesVersion>
<mavenChangesVersion>3.0.0-M1</mavenChangesVersion>
<mavenJavadocPluginVersion>3.11.2</mavenJavadocPluginVersion>
<mavenPmdPluginVersion>3.26.0</mavenPmdPluginVersion>
<!-- Used to generate download page for RAT during site builds, please adapt versions manually BEFORE doing a release -->
Expand All @@ -79,6 +79,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>
Expand Down Expand Up @@ -237,8 +243,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>
Expand All @@ -249,12 +253,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>
Expand Down Expand Up @@ -330,7 +392,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.8.0</version>
<reportSets>
<reportSet>
<reports>
Expand Down Expand Up @@ -455,10 +517,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>
Expand Down
Loading
Loading