Prepare simple site for plugin

slawekjaranowski · slawekjaranowski · commit 75164fd9ca78 · 2025-10-11T16:43:54.000+02:00
diff --git a/pom.xml b/pom.xml
@@ -12,17 +12,21 @@
   <version>1.6.1-SNAPSHOT</version>
 
   <name>Plexus Testing</name>
+  <description>Library to help testing plexus components</description>
+  <url>https://codehaus-plexus.github.io/plexus-testing/</url>
 
   <scm>
     <connection>scm:git:https://github.com/codehaus-plexus/plexus-testing.git</connection>
     <developerConnection>${project.scm.connection}</developerConnection>
     <tag>HEAD</tag>
     <url>https://github.com/codehaus-plexus/plexus-testing</url>
   </scm>
+
   <issueManagement>
     <system>github</system>
     <url>https://github.com/codehaus-plexus/plexus-testing/issues</url>
   </issueManagement>
+
   <distributionManagement>
     <site>
       <id>github:gh-pages</id>
@@ -70,4 +74,26 @@
     </dependency>
   </dependencies>
 
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-scm-publish-plugin</artifactId>
+        <configuration>
+          <content>${project.reporting.outputDirectory}</content>
+          <!-- mono-module doesn't require site:stage -->
+        </configuration>
+        <executions>
+          <execution>
+            <id>scm-publish</id>
+            <!-- deploy site with maven-scm-publish-plugin -->
+            <goals>
+              <goal>publish-scm</goal>
+            </goals>
+            <phase>site-deploy</phase>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
 </project>
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
@@ -0,0 +1,14 @@
+# Plexus Testing
+
+Library to help testing plexus components
+
+## Example usage
+
+### Test class
+
+<!-- MACRO{snippet|id=test-class|file=src/test/java/org/codehaus/plexus/testing/PlexusTestJavaxTest.java} -->
+
+### Used classes in test
+
+<!-- MACRO{snippet|id=test-component|file=src/test/java/org/codehaus/plexus/testing/TestJavaxComponent.java} -->
+<!-- MACRO{snippet|id=test-component2|file=src/test/java/org/codehaus/plexus/testing/TestJavaxComponent2.java} -->
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<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">
+
+  <body>
+    <menu name="Overview">
+      <item name="Introduction" href="index.html"/>
+      <item name="Javadoc" href="apidocs/index.html"/>
+    </menu>
+
+    <menu ref="parent"/>
+    <menu ref="reports"/>
+  </body>
+</site>
diff --git a/src/test/java/org/codehaus/plexus/testing/PlexusTestJavaxTest.java b/src/test/java/org/codehaus/plexus/testing/PlexusTestJavaxTest.java
@@ -18,7 +18,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+// START SNIPPET: test-class
 import javax.inject.Inject;
 
 import org.junit.jupiter.api.Test;
@@ -37,3 +37,4 @@ void dependencyShouldBeInjected() {
         assertNotNull(testJavaxComponent.getTestComponent2());
     }
 }
+// END SNIPPET: test-class
diff --git a/src/test/java/org/codehaus/plexus/testing/TestJavaxComponent.java b/src/test/java/org/codehaus/plexus/testing/TestJavaxComponent.java
@@ -19,6 +19,7 @@
  * under the License.
  */
 
+// START SNIPPET: test-component
 import javax.inject.Inject;
 import javax.inject.Named;
 
@@ -31,3 +32,4 @@ public TestJavaxComponent2 getTestComponent2() {
         return testJavaxComponent2;
     }
 }
+// END SNIPPET: test-component
diff --git a/src/test/java/org/codehaus/plexus/testing/TestJavaxComponent2.java b/src/test/java/org/codehaus/plexus/testing/TestJavaxComponent2.java
@@ -19,7 +19,9 @@
  * under the License.
  */
 
+// START SNIPPET: test-component2
 import javax.inject.Named;
 
 @Named
 public class TestJavaxComponent2 {}
+// END SNIPPET: test-component2

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`* specific language governing permissions and limitations`
`19`	`19`	`* under the License.`
`20`	`20`	`*/`
`21`		`-`
	`21`	`+// START SNIPPET: test-class`
`22`	`22`	`import javax.inject.Inject;`
`23`	`23`
`24`	`24`	`import org.junit.jupiter.api.Test;`
`@@ -37,3 +37,4 @@ void dependencyShouldBeInjected() {`
`37`	`37`	`assertNotNull(testJavaxComponent.getTestComponent2());`
`38`	`38`	`}`
`39`	`39`	`}`
	`40`	`+// END SNIPPET: test-class`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`* under the License.`
`20`	`20`	`*/`
`21`	`21`
	`22`	`+// START SNIPPET: test-component`
`22`	`23`	`import javax.inject.Inject;`
`23`	`24`	`import javax.inject.Named;`
`24`	`25`
`@@ -31,3 +32,4 @@ public TestJavaxComponent2 getTestComponent2() {`
`31`	`32`	`return testJavaxComponent2;`
`32`	`33`	`}`
`33`	`34`	`}`
	`35`	`+// END SNIPPET: test-component`