Set-up Maven plugin to generate OmniServices documentation automatica…

…lly.
omnifaces · Jan 2, 2022 · 4f06016 · 4f06016
1 parent da3c54f
commit 4f06016
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 44 deletions.
diff --git 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>
 
@@ -71,11 +71,11 @@
 
         <!-- Test versions. -->
         <jacoco.version>0.8.7</jacoco.version>
-        <glassfish6.version>6.2.3</glassfish6.version>
-        <payara5.version>5.2021.9</payara5.version>
-        <wildfly.version>25.0.1.Final</wildfly.version>
-        <tomee9.version>9.0.0-M7</tomee9.version>
-        <liberty.version>21.0.0.12</liberty.version>
+		<glassfish6.version>6.2.3</glassfish6.version>
+		<payara5.version>5.2021.9</payara5.version>
+		<wildfly.version>25.0.1.Final</wildfly.version>
+		<tomee9.version>9.0.0-M7</tomee9.version>
+		<liberty.version>21.0.0.12</liberty.version>
         <maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
     </properties>
 
@@ -261,7 +261,30 @@
                 </configuration>
             </plugin>
 
-            <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>
                 <version>1.0-m5.1</version>
@@ -356,27 +379,28 @@
             </dependencies>
         </profile>
 
-        <profile>
-            <id>payara5</id>
+		<profile>
+			<id>payara5</id>
 
-            <dependencies>
-                <dependency>
-                    <groupId>fish.payara.extras</groupId>
-                    <artifactId>payara-embedded-all</artifactId>
-                    <version>${payara5.version}</version>
-                    <scope>test</scope>
-                </dependency>
+			<dependencies>
+				<dependency>
+					<groupId>fish.payara.extras</groupId>
+					<artifactId>payara-embedded-all</artifactId>
+					<version>${payara5.version}</version>
+					<scope>test</scope>
+				</dependency>
 
-                <dependency>
-                    <groupId>fish.payara.arquillian</groupId>
-                    <artifactId>arquillian-payara-server-embedded</artifactId>
-                    <version>2.4.5</version>
-                </dependency>
-            </dependencies>
-        </profile>
+				<dependency>
+					<groupId>fish.payara.arquillian</groupId>
+					<artifactId>arquillian-payara-server-embedded</artifactId>
+					<version>2.4.5</version>
 
-        <profile>
-            <id>wildfly</id>
+				</dependency>
+			</dependencies>
+		</profile>
+
+		<profile>
+			<id>wildfly</id>
 
             <dependencies>
                 <dependency>
@@ -474,23 +498,23 @@
                                 <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>
+								<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>

diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc
@@ -0,0 +1,2 @@
+= OmniServices v{project-version}
+