rework ITs to better integrate into skin documentation (#33)

* rework ITs to better integrate into skin documentation * add missing breadcrumbs for skin documentation navigation * Build site with package Co-authored-by: Slawomir Jaranowski <[email protected]>
apache · Jun 10, 2022 · 171292d · 171292d
1 parent bfba459
commit 171292d
Show file tree

Hide file tree

Showing 81 changed files with 277 additions and 87 deletions.
diff --git a/.github/workflows/maven-verify.yml b/.github/workflows/maven-verify.yml
@@ -25,4 +25,6 @@ jobs:
   build:
     name: Verify
     uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v2
+    with:
+      ff-site-goal: '-DskipTests -P reporting package site site:stage'
 
diff --git a/README.md b/README.md
@@ -64,7 +64,7 @@ There are some guidelines which will make applying PRs easier for us:
  Optional supplemental description.
 ```
 + Make sure you have added the necessary tests (JUnit/IT) for your changes.
-+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was accidentally broken.
++ Run all the tests with `mvn -Prun-its,reporting verify site` to assure nothing else was accidentally broken.
 + Submit a pull request to the repository in the Apache organization.
 + Update your JIRA ticket and include a link to the pull request in the ticket.
 

diff --git a/src/it/mskins-10/pom.xml b/src/it/mskins-10/pom.xml
@@ -26,7 +26,10 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>mskins-10</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
+
+  <name>@project.name@ IT, MSKINS-10</name>
+  <url>https://maven.apache.org/skins/@project.artifactId@/mskins-10/</url>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-10/src/site/site.xml b/src/it/mskins-10/src/site/site.xml
@@ -32,6 +32,10 @@
   </skin>
 
   <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
     <menu>
       <item name="Suppress line wrapping in navigation caused by spaces or hyphens" href="./"/>
       <item name="Beer" href="beer.html" collapse="true">

diff --git a/src/it/mskins-107/pom.xml b/src/it/mskins-107/pom.xml
@@ -26,7 +26,10 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>mskins-107</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
+
+  <name>@project.name@ IT, MSKINS-107</name>
+  <url>https://maven.apache.org/skins/@project.artifactId@/mskins-107/</url>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-107/src/site/site.xml b/src/it/mskins-107/src/site/site.xml
@@ -31,5 +31,10 @@
     <version>${skinVersion}</version>
   </skin>
 
-  <body />
+  <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
+  </body>
 </project>
diff --git a/src/it/mskins-13/pom.xml b/src/it/mskins-13/pom.xml
@@ -26,10 +26,10 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>@project.artifactId@-mskins-13</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <name>@project.name@ IT, MSKINS-13</name>
-  <url>http://maven.apache.org/skins/@project.artifactId@/mskins-13/</url>
+  <url>https://maven.apache.org/skins/@project.artifactId@/mskins-13/</url>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-13/src/site/site.xml b/src/it/mskins-13/src/site/site.xml
@@ -41,6 +41,10 @@
   </custom>
 
   <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
     <menu name="Main">
       <item name="Sub" href="nowhere.html" />
     </menu>

diff --git a/src/it/mskins-14/pom.xml b/src/it/mskins-14/pom.xml
@@ -26,10 +26,10 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>@project.artifactId@-mskins-14</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <name>@project.name@ IT, MSKINS-14</name>
-  <url>http://maven.apache.org/skins/@project.artifactId@/mskins-14/</url>
+  <url>https://maven.apache.org/skins/@project.artifactId@/mskins-14/</url>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-14/src/site/site.xml b/src/it/mskins-14/src/site/site.xml
@@ -37,5 +37,10 @@
     </fluidoSkin>
   </custom>
 
-  <body/>
+  <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
+  </body>
 </project>
diff --git a/src/it/mskins-143_default/pom.xml b/src/it/mskins-143_default/pom.xml
@@ -26,7 +26,7 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>mskins-143_default</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-143_default/src/site/site.xml b/src/it/mskins-143_default/src/site/site.xml
@@ -31,7 +31,16 @@
     <version>${skinVersion}</version>
   </skin>
 
-  <body/>
+  <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
+  </body>
+
+  <!-- START SNIPPET: skin-custom-config -->
+  <!-- no custom config -->
+  <!-- END SNIPPET: skin-custom-config -->
 
   <googleAnalyticsAccountId>FOO-BAR</googleAnalyticsAccountId>
 

diff --git a/src/it/mskins-143_false/pom.xml b/src/it/mskins-143_false/pom.xml
@@ -26,7 +26,7 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>mskins-143_false</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-143_false/src/site/site.xml b/src/it/mskins-143_false/src/site/site.xml
@@ -42,7 +42,12 @@
   </custom>
   <!-- END SNIPPET: skin-custom-config -->
 
-  <body/>
+  <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
+  </body>
 
   <googleAnalyticsAccountId>FOO-BAR</googleAnalyticsAccountId>
 

diff --git a/src/it/mskins-143_true/pom.xml b/src/it/mskins-143_true/pom.xml
@@ -26,7 +26,7 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>mskins-143_true</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-143_true/src/site/site.xml b/src/it/mskins-143_true/src/site/site.xml
@@ -42,7 +42,12 @@
   </custom>
   <!-- END SNIPPET: skin-custom-config -->
 
-  <body/>
+  <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
+  </body>
 
   <googleAnalyticsAccountId>FOO-BAR</googleAnalyticsAccountId>
 

diff --git a/src/it/mskins-14_sitesearch/pom.xml b/src/it/mskins-14_sitesearch/pom.xml
@@ -26,10 +26,10 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>@project.artifactId@-mskins-14_sitesearch</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <name>@project.name@ IT, MSKINS-14 (sitesearch)</name>
-  <url>http://maven.apache.org/skins/@project.artifactId@/mskins-14_sitesearch/</url>
+  <url>https://maven.apache.org/skins/@project.artifactId@/mskins-14_sitesearch/</url>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-14_sitesearch/src/site/site.xml b/src/it/mskins-14_sitesearch/src/site/site.xml
@@ -39,5 +39,10 @@
     </fluidoSkin>
   </custom>
 
-  <body/>
+  <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
+  </body>
 </project>
diff --git a/src/it/mskins-15/pom.xml b/src/it/mskins-15/pom.xml
@@ -26,10 +26,10 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>@project.artifactId@-mskins-15</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <name>@project.name@ IT, MSKINS-15</name>
-  <url>http://maven.apache.org/skins/@project.artifactId@/mskins-15/</url>
+  <url>https://maven.apache.org/skins/@project.artifactId@/mskins-15/</url>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-15/src/site/site.xml b/src/it/mskins-15/src/site/site.xml
@@ -39,6 +39,10 @@
   </custom>
 
   <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
     <links>
       <item name="Maven Skins" href="http://maven.apache.org/skins/"/>
       <item name="Twitter Bootstrap" href="http://twitter.github.com/bootstrap/"/>

diff --git a/src/it/mskins-16/pom.xml b/src/it/mskins-16/pom.xml
@@ -26,10 +26,10 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>@project.artifactId@-mskins-16</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <name>@project.name@ IT, MSKINS-16</name>
-  <url>http://maven.apache.org/skins/@project.artifactId@/mskins-16/</url>
+  <url>https://maven.apache.org/skins/@project.artifactId@/mskins-16/</url>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-16/src/site/site.xml b/src/it/mskins-16/src/site/site.xml
@@ -47,5 +47,10 @@
     <src>images/apache-maven-project-2.png</src>
   </bannerRight>
 
-  <body/>
+  <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
+  </body>
 </project>
diff --git a/src/it/mskins-161/pom.xml b/src/it/mskins-161/pom.xml
@@ -26,10 +26,10 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>@project.artifactId@-mskins-161-parent</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
   <packaging>pom</packaging>
   <name>@project.name@ IT, MSKINS-161</name>
-  <url>http://maven.apache.org/skins/@project.artifactId@/mskins-161/</url>
+  <url>https://maven.apache.org/skins/@project.artifactId@/mskins-161/</url>
 
   <modules>
     <module>sidebar-fb-like-share</module>

diff --git a/src/it/mskins-161/sidebar-fb-like-share/pom.xml b/src/it/mskins-161/sidebar-fb-like-share/pom.xml
@@ -21,11 +21,10 @@
   <parent>
     <groupId>org.apache.maven.skins.its</groupId>
     <artifactId>@project.artifactId@-mskins-161-parent</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>@project.version@</version>
   </parent>
 
   <artifactId>@project.artifactId@-mskins-161-sidebar-fb-like-share</artifactId>
-  <version>1.0-SNAPSHOT</version>
   <name>@project.name@ IT, MSKINS-161 sidebar-fb-like-share</name>
   <url>http://maven.apache.org/skins/@project.artifactId@/mskins-161/</url>
 

diff --git a/src/it/mskins-161/sidebar-fb-recommend-share/pom.xml b/src/it/mskins-161/sidebar-fb-recommend-share/pom.xml
@@ -21,11 +21,10 @@
   <parent>
     <groupId>org.apache.maven.skins.its</groupId>
     <artifactId>@project.artifactId@-mskins-161-parent</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>@project.version@</version>
   </parent>
 
   <artifactId>@project.artifactId@-mskins-161-sidebar-fb-recommend-share</artifactId>
-  <version>1.0-SNAPSHOT</version>
   <name>@project.name@ IT, MSKINS-161 sidebar-fb-recommend-share</name>
   <url>http://maven.apache.org/skins/@project.artifactId@/mskins-161/</url>
 

diff --git a/src/it/mskins-161/topbar-fb-like-share/pom.xml b/src/it/mskins-161/topbar-fb-like-share/pom.xml
@@ -21,11 +21,10 @@
   <parent>
     <groupId>org.apache.maven.skins.its</groupId>
     <artifactId>@project.artifactId@-mskins-161-parent</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>@project.version@</version>
   </parent>
 
   <artifactId>@project.artifactId@-mskins-161-topbar-fb-like-share</artifactId>
-  <version>1.0-SNAPSHOT</version>
   <name>@project.name@ IT, MSKINS-161 topbar-fb-like-share</name>
   <url>http://maven.apache.org/skins/@project.artifactId@/mskins-161/</url>
 

diff --git a/src/it/mskins-161/topbar-fb-recommend-share/pom.xml b/src/it/mskins-161/topbar-fb-recommend-share/pom.xml
@@ -21,11 +21,10 @@
   <parent>
     <groupId>org.apache.maven.skins.its</groupId>
     <artifactId>@project.artifactId@-mskins-161-parent</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>@project.version@</version>
   </parent>
 
   <artifactId>@project.artifactId@-mskins-161-topbar-fb-recommend-share</artifactId>
-  <version>1.0-SNAPSHOT</version>
   <name>@project.name@ IT, MSKINS-161 topbar-fb-recommend-share</name>
   <url>http://maven.apache.org/skins/@project.artifactId@/mskins-161/</url>
 

diff --git a/src/it/mskins-17/pom.xml b/src/it/mskins-17/pom.xml
@@ -26,10 +26,10 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>@project.artifactId@-mskins-17</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <name>@project.name@ IT, MSKINS-17</name>
-  <url>http://maven.apache.org/skins/@project.artifactId@/mskins-17/</url>
+  <url>https://maven.apache.org/skins/@project.artifactId@/mskins-17/</url>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-17/src/site/site.xml b/src/it/mskins-17/src/site/site.xml
@@ -39,5 +39,10 @@
 
   <publishDate format="yyyy-MM-dd" position="right" />
 
-  <body/>
+  <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
+  </body>
 </project>
diff --git a/src/it/mskins-174/pom.xml b/src/it/mskins-174/pom.xml
@@ -27,7 +27,7 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>mskins-174</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-177-apache-analytics/pom.xml b/src/it/mskins-177-apache-analytics/pom.xml
@@ -26,7 +26,7 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>mskins-177_apache_analytics</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <properties>
     <skinName>@project.name@</skinName>

diff --git a/src/it/mskins-177-apache-analytics/src/site/site.xml b/src/it/mskins-177-apache-analytics/src/site/site.xml
@@ -47,6 +47,10 @@
   <!-- END SNIPPET: skin-apache-analytics -->
 
   <body>
+    <breadcrumbs>
+      <item name="Apache Maven Fluido Skin"  href="https://maven.apache.org/skins/maven-fluido-skin/index.html" />
+      <item name="Maven Fluido Skin ITs"  href="https://maven.apache.org/skins/maven-fluido-skin/ITs.html" />
+    </breadcrumbs>
     <head/>
   </body>
 

diff --git a/src/it/mskins-177-matomo-no-options/pom.xml b/src/it/mskins-177-matomo-no-options/pom.xml
@@ -26,7 +26,7 @@
 
   <groupId>org.apache.maven.skins.its</groupId>
   <artifactId>mskins-177_matomo-no-options</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>@project.version@</version>
 
   <properties>
     <skinName>@project.name@</skinName>