From 56d765a1dc35dcc29c4002106be3450b47b0c88b Mon Sep 17 00:00:00 2001
From: Jan Beernink <jan.beernink@gmail.com>
Date: Sat, 2 Jan 2021 11:41:07 +0100
Subject: [PATCH] Set-up Maven plugin to generate OmniServices documentation
 automatically.

---
 pom.xml                      | 451 ++++++++++++++++++-----------------
 src/main/asciidoc/index.adoc |   2 +
 2 files changed, 239 insertions(+), 214 deletions(-)
 create mode 100644 src/main/asciidoc/index.adoc

diff --git a/pom.xml b/pom.xml
index 093ac92..53c6020 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project
-	xmlns="http://maven.apache.org/POM/4.0.0"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
+		xmlns="http://maven.apache.org/POM/4.0.0"
+		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
 >
 	<modelVersion>4.0.0</modelVersion>
 	<prerequisites>
@@ -67,7 +67,7 @@
 		<!-- Minimum required Java versions. -->
 		<javase.version>1.8</javase.version>
 		<javaee.version>7</javaee.version>
-		
+
 		<!-- Essential Maven defaults. -->
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
@@ -76,11 +76,11 @@
 
 		<!-- Test versions. -->
 		<jacoco.version>0.7.4.201502262128</jacoco.version>
-        <glassfish.version>4.1.1</glassfish.version>
-        <payara.version>4.1.1.162</payara.version>
-        <wildfly.version>10.0.0.Final</wildfly.version>
-        <tomee.version>7.0.1</tomee.version>
-        <liberty.version>16.0.0.2</liberty.version>
+		<glassfish.version>4.1.1</glassfish.version>
+		<payara.version>4.1.1.162</payara.version>
+		<wildfly.version>10.0.0.Final</wildfly.version>
+		<tomee.version>7.0.1</tomee.version>
+		<liberty.version>16.0.0.2</liberty.version>
 	</properties>
 
 	<dependencies>
@@ -251,6 +251,29 @@
 				</configuration>
 			</plugin>
 
+			<!-- Generate documentation from source. -->
+			<plugin>
+				<groupId>org.asciidoctor</groupId>
+				<artifactId>asciidoctor-maven-plugin</artifactId>
+				<version>1.5.6</version>
+				<configuration>
+					<attributes>
+						<project-version>${project.version}</project-version>
+						<linkcss>true</linkcss>
+					</attributes>
+					<backend>html5</backend>
+				</configuration>
+				<executions>
+					<execution>
+						<id>output-html</id>
+						<phase>generate-resources</phase>
+						<goals>
+							<goal>process-asciidoc</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+
 			<plugin>
 				<groupId>external.atlassian.jgitflow</groupId>
 				<artifactId>jgitflow-maven-plugin</artifactId>
@@ -334,211 +357,211 @@
 			</dependencies>
 		</profile>
 
-        <profile>
-            <id>payara</id>
-
-            <dependencies>
-	           <dependency>
-	               <groupId>fish.payara.extras</groupId>
-	               <artifactId>payara-embedded-all</artifactId>
-	               <version>${payara.version}</version>
-	               <scope>test</scope>
-                </dependency>
-
-                <dependency>
-                    <groupId>org.jboss.arquillian.container</groupId>
-                    <artifactId>arquillian-glassfish-embedded-3.1</artifactId>
-                    <version>1.0.0.CR4</version>
-                    <scope>test</scope>
-                </dependency>
-            </dependencies>
-        </profile>
-
-        <profile>
-            <id>wildfly</id>
-
-            <dependencies>
-                <dependency>
-                    <groupId>org.wildfly.arquillian</groupId>
-                    <artifactId>wildfly-arquillian-container-embedded</artifactId>
-                    <version>2.0.0.Final</version>
-                    <scope>test</scope>
-                </dependency>
-            </dependencies>
-
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-dependency-plugin</artifactId>
-                        <executions>
-                            <execution>
-                                <id>unpack</id>
-                                <phase>process-test-classes</phase>
-                                <goals>
-                                    <goal>unpack</goal>
-                                </goals>
-                                <configuration>
-                                    <artifactItems>
-                                        <artifactItem>
-                                            <groupId>org.wildfly</groupId>
-                                            <artifactId>wildfly-dist</artifactId>
-                                            <version>${wildfly.version}</version>
-                                            <type>zip</type>
-                                            <overWrite>false</overWrite>
-                                            <outputDirectory>${project.build.directory}</outputDirectory>
-                                        </artifactItem>
-                                    </artifactItems>
-                                </configuration>
-                            </execution>
-                        </executions>
-                    </plugin>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-surefire-plugin</artifactId>
-                        <configuration>
-                            <systemPropertyVariables>
-                                <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
-                            </systemPropertyVariables>
-                            <environmentVariables>
-                                <JBOSS_HOME>${project.build.directory}/wildfly-${wildfly.version}</JBOSS_HOME>
-                                <module.path>${project.build.directory}/wildfly-${wildfly.version}/modules</module.path>
-                            </environmentVariables>
-                        </configuration>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
-
-
-        <profile>
-            <id>tomee</id>
-
-            <dependencies>
-                <dependency>
-                    <groupId>org.apache.tomee</groupId>
-                    <artifactId>apache-tomee</artifactId>
-                    <version>${tomee.version}</version>
-                    <scope>test</scope>
-                    <type>zip</type>
-                    <classifier>plus</classifier>
-                </dependency>
-
-                <dependency>
-                    <groupId>org.apache.tomee</groupId>
-                    <artifactId>arquillian-tomee-remote</artifactId>
-                    <version>${tomee.version}</version>
-                    <scope>test</scope>
-                    <exclusions>
-                        <exclusion>
-                            <groupId>org.apache.tomee</groupId>
-                            <artifactId>arquillian-openejb-transaction-provider</artifactId>
-                        </exclusion>
-                    </exclusions>
-                </dependency>
-            </dependencies>
-
-            <build>
-                <plugins>
-                    <plugin>
-                        <artifactId>maven-surefire-plugin</artifactId>
-                        <configuration>
-                            <argLine>-DTOMEE_LOCK_FILE=${user.dir}/.tomee-ports.lock</argLine>
-                            <systemPropertyVariables>
-                                <tomee.stopPort>-1</tomee.stopPort>
-                                <tomee.httpPort>-1</tomee.httpPort>
-                                <tomee.httpsPort>-1</tomee.httpsPort>
-                                <tomee.ajpPort>-1</tomee.ajpPort>
-
-                                <tomee.dir>target/tomee/server</tomee.dir>
-                                <tomee.appWorkingDir>target/tomee/arquillian</tomee.appWorkingDir>
-                                <tomee.cleanOnStartUp>true</tomee.cleanOnStartUp>
-                                <tomee.classifier>plus</tomee.classifier>
-                                <tomee.properties>
-                                    openejb.environment.default=true
-                                </tomee.properties>
-                            </systemPropertyVariables>
-                        </configuration>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
-
-
-        <profile>
-            <id>liberty</id>
-
-            <dependencies>
-                <dependency>
-                    <groupId>org.jboss.arquillian.container</groupId>
-                    <artifactId>arquillian-wlp-managed-8.5</artifactId>
-                    <version>1.0.0.Beta2</version>
-                    <scope>test</scope>
-                </dependency>
-            </dependencies>
-
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-dependency-plugin</artifactId>
-                        <executions>
-                            <execution>
-                                <id>unpack</id>
-                                <phase>process-test-classes</phase>
-                                <goals>
-                                    <goal>unpack</goal>
-                                </goals>
-                                <configuration>
-                                    <artifactItems>
-                                        <artifactItem>
-                                            <groupId>com.ibm.websphere.appserver.runtime</groupId>
-                                            <artifactId>wlp-javaee7</artifactId>
-                                            <version>${liberty.version}</version>
-                                            <type>zip</type>
-                                            <overWrite>false</overWrite>
-                                            <outputDirectory>${project.build.directory}</outputDirectory>
-                                        </artifactItem>
-                                    </artifactItems>
-                                </configuration>
-                            </execution>
-                        </executions>
-                    </plugin>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-antrun-plugin</artifactId>
-                        <version>1.1</version>
-                        <executions>
-                            <execution>
-                                <phase>process-test-classes</phase>
-                                <goals>
-                                    <goal>run</goal>
-                                </goals>
-                                <configuration>
-                                    <tasks>
-                                        <echo>Copying server.xml</echo>
-                                        <copy
-                                            file="src/test/resources/server.xml"
-                                            tofile="${project.build.directory}/wlp/templates/servers/defaultServer/server.xml"
-                                        />
-                                    </tasks>
-                                </configuration>
-                            </execution>
-                        </executions>
-                    </plugin>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-surefire-plugin</artifactId>
-                        <configuration>
-                            <systemPropertyVariables>
-                                <arquillian.launch>liberty</arquillian.launch>
-                                <arquillian.liberty.wlpHome>${project.build.directory}/wlp</arquillian.liberty.wlpHome>
-                            </systemPropertyVariables>
-                        </configuration>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
+		<profile>
+			<id>payara</id>
+
+			<dependencies>
+				<dependency>
+					<groupId>fish.payara.extras</groupId>
+					<artifactId>payara-embedded-all</artifactId>
+					<version>${payara.version}</version>
+					<scope>test</scope>
+				</dependency>
+
+				<dependency>
+					<groupId>org.jboss.arquillian.container</groupId>
+					<artifactId>arquillian-glassfish-embedded-3.1</artifactId>
+					<version>1.0.0.CR4</version>
+					<scope>test</scope>
+				</dependency>
+			</dependencies>
+		</profile>
+
+		<profile>
+			<id>wildfly</id>
+
+			<dependencies>
+				<dependency>
+					<groupId>org.wildfly.arquillian</groupId>
+					<artifactId>wildfly-arquillian-container-embedded</artifactId>
+					<version>2.0.0.Final</version>
+					<scope>test</scope>
+				</dependency>
+			</dependencies>
+
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-dependency-plugin</artifactId>
+						<executions>
+							<execution>
+								<id>unpack</id>
+								<phase>process-test-classes</phase>
+								<goals>
+									<goal>unpack</goal>
+								</goals>
+								<configuration>
+									<artifactItems>
+										<artifactItem>
+											<groupId>org.wildfly</groupId>
+											<artifactId>wildfly-dist</artifactId>
+											<version>${wildfly.version}</version>
+											<type>zip</type>
+											<overWrite>false</overWrite>
+											<outputDirectory>${project.build.directory}</outputDirectory>
+										</artifactItem>
+									</artifactItems>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-surefire-plugin</artifactId>
+						<configuration>
+							<systemPropertyVariables>
+								<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
+							</systemPropertyVariables>
+							<environmentVariables>
+								<JBOSS_HOME>${project.build.directory}/wildfly-${wildfly.version}</JBOSS_HOME>
+								<module.path>${project.build.directory}/wildfly-${wildfly.version}/modules</module.path>
+							</environmentVariables>
+						</configuration>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+
+
+		<profile>
+			<id>tomee</id>
+
+			<dependencies>
+				<dependency>
+					<groupId>org.apache.tomee</groupId>
+					<artifactId>apache-tomee</artifactId>
+					<version>${tomee.version}</version>
+					<scope>test</scope>
+					<type>zip</type>
+					<classifier>plus</classifier>
+				</dependency>
+
+				<dependency>
+					<groupId>org.apache.tomee</groupId>
+					<artifactId>arquillian-tomee-remote</artifactId>
+					<version>${tomee.version}</version>
+					<scope>test</scope>
+					<exclusions>
+						<exclusion>
+							<groupId>org.apache.tomee</groupId>
+							<artifactId>arquillian-openejb-transaction-provider</artifactId>
+						</exclusion>
+					</exclusions>
+				</dependency>
+			</dependencies>
+
+			<build>
+				<plugins>
+					<plugin>
+						<artifactId>maven-surefire-plugin</artifactId>
+						<configuration>
+							<argLine>-DTOMEE_LOCK_FILE=${user.dir}/.tomee-ports.lock</argLine>
+							<systemPropertyVariables>
+								<tomee.stopPort>-1</tomee.stopPort>
+								<tomee.httpPort>-1</tomee.httpPort>
+								<tomee.httpsPort>-1</tomee.httpsPort>
+								<tomee.ajpPort>-1</tomee.ajpPort>
+
+								<tomee.dir>target/tomee/server</tomee.dir>
+								<tomee.appWorkingDir>target/tomee/arquillian</tomee.appWorkingDir>
+								<tomee.cleanOnStartUp>true</tomee.cleanOnStartUp>
+								<tomee.classifier>plus</tomee.classifier>
+								<tomee.properties>
+									openejb.environment.default=true
+								</tomee.properties>
+							</systemPropertyVariables>
+						</configuration>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+
+
+		<profile>
+			<id>liberty</id>
+
+			<dependencies>
+				<dependency>
+					<groupId>org.jboss.arquillian.container</groupId>
+					<artifactId>arquillian-wlp-managed-8.5</artifactId>
+					<version>1.0.0.Beta2</version>
+					<scope>test</scope>
+				</dependency>
+			</dependencies>
+
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-dependency-plugin</artifactId>
+						<executions>
+							<execution>
+								<id>unpack</id>
+								<phase>process-test-classes</phase>
+								<goals>
+									<goal>unpack</goal>
+								</goals>
+								<configuration>
+									<artifactItems>
+										<artifactItem>
+											<groupId>com.ibm.websphere.appserver.runtime</groupId>
+											<artifactId>wlp-javaee7</artifactId>
+											<version>${liberty.version}</version>
+											<type>zip</type>
+											<overWrite>false</overWrite>
+											<outputDirectory>${project.build.directory}</outputDirectory>
+										</artifactItem>
+									</artifactItems>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-antrun-plugin</artifactId>
+						<version>1.1</version>
+						<executions>
+							<execution>
+								<phase>process-test-classes</phase>
+								<goals>
+									<goal>run</goal>
+								</goals>
+								<configuration>
+									<tasks>
+										<echo>Copying server.xml</echo>
+										<copy
+												file="src/test/resources/server.xml"
+												tofile="${project.build.directory}/wlp/templates/servers/defaultServer/server.xml"
+										/>
+									</tasks>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-surefire-plugin</artifactId>
+						<configuration>
+							<systemPropertyVariables>
+								<arquillian.launch>liberty</arquillian.launch>
+								<arquillian.liberty.wlpHome>${project.build.directory}/wlp</arquillian.liberty.wlpHome>
+							</systemPropertyVariables>
+						</configuration>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
 
 
 		<profile>
diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc
new file mode 100644
index 0000000..bde2903
--- /dev/null
+++ b/src/main/asciidoc/index.adoc
@@ -0,0 +1,2 @@
+= OmniServices v{project-version}
+