Building Oxygen XML WebHelp Output on Jenkins

This procedure assumes that you have already integrated, configured, and registered the WebHelp plugin with the DITA Open Toolkit.

To integrate WebHelp output with the Jenkins continuous integration tool, follow these steps:

1. Create a Maven project to incorporate the DITA-OT that already integrates Oxygen XML WebHelp.
2. Go to the root of your Maven project and edit the pom.xml file to include the following fragment:

   <properties>
     <oxygen-webhelp>${basedir}/tools/DITA-OT1.8.5/
          plugins/com.oxygenxml.webhelp</oxygen-webhelp>
   </properties>
   
   <plugin>
     <artifactId>exec-maven-plugin</artifactId>
     <groupId>org.codehaus.mojo</groupId>
     <executions>
       <execution><!-- Run our version calculation script -->
         <id>Version Calculation</id>
         <phase>generate-sources</phase>
         <goals>
           <goal>exec</goal>
         </goals>
         <configuration>
           <executable>${oxygen-webhelp}/ditaWebhelp.bat</executable>
         </configuration>
       </execution>
     </executions>
   </plugin>

   Note

   In the fragment above it is assumed that you are using DITA-OT version 1.8.5. If you are using another version, please adjust the path accordingly.
3. Go to the Jenkins top page and create a new Jenkins job. Configure this job to suit your particular requirements, such as the build frequency and location of the Maven project.