Skip to content

Commit 4f06016

Browse files
committed
Set-up Maven plugin to generate OmniServices documentation automatically.
1 parent da3c54f commit 4f06016

File tree

2 files changed

+70
-44
lines changed

2 files changed

+70
-44
lines changed

pom.xml

Lines changed: 68 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<project
3-
xmlns="http://maven.apache.org/POM/4.0.0"
4-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5-
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
3+
xmlns="http://maven.apache.org/POM/4.0.0"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
66
>
77
<modelVersion>4.0.0</modelVersion>
88

@@ -71,11 +71,11 @@
7171

7272
<!-- Test versions. -->
7373
<jacoco.version>0.8.7</jacoco.version>
74-
<glassfish6.version>6.2.3</glassfish6.version>
75-
<payara5.version>5.2021.9</payara5.version>
76-
<wildfly.version>25.0.1.Final</wildfly.version>
77-
<tomee9.version>9.0.0-M7</tomee9.version>
78-
<liberty.version>21.0.0.12</liberty.version>
74+
<glassfish6.version>6.2.3</glassfish6.version>
75+
<payara5.version>5.2021.9</payara5.version>
76+
<wildfly.version>25.0.1.Final</wildfly.version>
77+
<tomee9.version>9.0.0-M7</tomee9.version>
78+
<liberty.version>21.0.0.12</liberty.version>
7979
<maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
8080
</properties>
8181

@@ -261,7 +261,30 @@
261261
</configuration>
262262
</plugin>
263263

264-
<plugin>
264+
<!-- Generate documentation from source. -->
265+
<plugin>
266+
<groupId>org.asciidoctor</groupId>
267+
<artifactId>asciidoctor-maven-plugin</artifactId>
268+
<version>1.5.6</version>
269+
<configuration>
270+
<attributes>
271+
<project-version>${project.version}</project-version>
272+
<linkcss>true</linkcss>
273+
</attributes>
274+
<backend>html5</backend>
275+
</configuration>
276+
<executions>
277+
<execution>
278+
<id>output-html</id>
279+
<phase>generate-resources</phase>
280+
<goals>
281+
<goal>process-asciidoc</goal>
282+
</goals>
283+
</execution>
284+
</executions>
285+
</plugin>
286+
287+
<plugin>
265288
<groupId>external.atlassian.jgitflow</groupId>
266289
<artifactId>jgitflow-maven-plugin</artifactId>
267290
<version>1.0-m5.1</version>
@@ -356,27 +379,28 @@
356379
</dependencies>
357380
</profile>
358381

359-
<profile>
360-
<id>payara5</id>
382+
<profile>
383+
<id>payara5</id>
361384

362-
<dependencies>
363-
<dependency>
364-
<groupId>fish.payara.extras</groupId>
365-
<artifactId>payara-embedded-all</artifactId>
366-
<version>${payara5.version}</version>
367-
<scope>test</scope>
368-
</dependency>
385+
<dependencies>
386+
<dependency>
387+
<groupId>fish.payara.extras</groupId>
388+
<artifactId>payara-embedded-all</artifactId>
389+
<version>${payara5.version}</version>
390+
<scope>test</scope>
391+
</dependency>
369392

370-
<dependency>
371-
<groupId>fish.payara.arquillian</groupId>
372-
<artifactId>arquillian-payara-server-embedded</artifactId>
373-
<version>2.4.5</version>
374-
</dependency>
375-
</dependencies>
376-
</profile>
393+
<dependency>
394+
<groupId>fish.payara.arquillian</groupId>
395+
<artifactId>arquillian-payara-server-embedded</artifactId>
396+
<version>2.4.5</version>
377397

378-
<profile>
379-
<id>wildfly</id>
398+
</dependency>
399+
</dependencies>
400+
</profile>
401+
402+
<profile>
403+
<id>wildfly</id>
380404

381405
<dependencies>
382406
<dependency>
@@ -474,23 +498,23 @@
474498
<tomee.httpsPort>-1</tomee.httpsPort>
475499
<tomee.ajpPort>-1</tomee.ajpPort>
476500

477-
<tomee.dir>target/tomee/server</tomee.dir>
478-
<tomee.appWorkingDir>target/tomee/arquillian</tomee.appWorkingDir>
479-
<tomee.cleanOnStartUp>true</tomee.cleanOnStartUp>
480-
<tomee.classifier>plus</tomee.classifier>
481-
<tomee.properties>
482-
openejb.environment.default=true
483-
</tomee.properties>
484-
</systemPropertyVariables>
485-
</configuration>
486-
</plugin>
487-
</plugins>
488-
</build>
489-
</profile>
490-
491-
492-
<profile>
493-
<id>liberty</id>
501+
<tomee.dir>target/tomee/server</tomee.dir>
502+
<tomee.appWorkingDir>target/tomee/arquillian</tomee.appWorkingDir>
503+
<tomee.cleanOnStartUp>true</tomee.cleanOnStartUp>
504+
<tomee.classifier>plus</tomee.classifier>
505+
<tomee.properties>
506+
openejb.environment.default=true
507+
</tomee.properties>
508+
</systemPropertyVariables>
509+
</configuration>
510+
</plugin>
511+
</plugins>
512+
</build>
513+
</profile>
514+
515+
516+
<profile>
517+
<id>liberty</id>
494518

495519
<dependencies>
496520
<dependency>

src/main/asciidoc/index.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
= OmniServices v{project-version}
2+

0 commit comments

Comments
 (0)