docs/pom.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- vi: set et smarttab sw=4 tabstop=4: -->
   3 <!--
   4  Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   5
   6  This program and the accompanying materials are made available under the
   7  terms of the Eclipse Public License v1.0 which accompanies this distribution,
   8  and is available at http://www.eclipse.org/legal/epl-v10.html
   9 -->
  10 <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">
  11     <modelVersion>4.0.0</modelVersion>
  12     <parent>
  13         <groupId>org.opendaylight.odlparent</groupId>
  14         <artifactId>bundle-parent</artifactId>
  15         <version>13.0.9</version>
  16         <relativePath>../bundle-parent</relativePath>
  17     </parent>
  18
  19     <artifactId>odlparent-docs</artifactId>
  20     <packaging>jar</packaging>
  21     <name>${project.artifactId}</name>
  22     <description>ODL Root Parent documentation</description>
  23
  24     <properties>
  25         <maven.javadoc.failOnWarnings>true</maven.javadoc.failOnWarnings>
  26     </properties>
  27
  28     <dependencies>
  29         <dependency>
  30             <groupId>org.opendaylight.odlparent</groupId>
  31             <artifactId>bundles-test-lib</artifactId>
  32         </dependency>
  33         <dependency>
  34             <groupId>org.opendaylight.odlparent</groupId>
  35             <artifactId>features-test</artifactId>
  36             <version>${project.version}</version>
  37         </dependency>
  38         <dependency>
  39             <groupId>org.opendaylight.odlparent</groupId>
  40             <artifactId>filter-manifest-plugin</artifactId>
  41             <version>${project.version}</version>
  42         </dependency>
  43         <dependency>
  44             <groupId>org.opendaylight.odlparent</groupId>
  45             <artifactId>karaf-plugin</artifactId>
  46             <version>${project.version}</version>
  47         </dependency>
  48         <dependency>
  49             <groupId>org.opendaylight.odlparent</groupId>
  50             <artifactId>karaf-util</artifactId>
  51             <version>${project.version}</version>
  52         </dependency>
  53         <dependency>
  54             <groupId>org.opendaylight.odlparent</groupId>
  55             <artifactId>logging-markers</artifactId>
  56         </dependency>
  57
  58         <!-- Also add dependencies we are using -->
  59         <dependency>
  60             <groupId>org.apache.maven</groupId>
  61             <artifactId>maven-core</artifactId>
  62             <scope>provided</scope>
  63         </dependency>
  64         <dependency>
  65             <groupId>org.apache.maven.plugin-tools</groupId>
  66             <artifactId>maven-plugin-annotations</artifactId>
  67             <version>3.8.2</version>
  68             <scope>provided</scope>
  69         </dependency>
  70         <dependency>
  71             <groupId>junit</groupId>
  72             <artifactId>junit</artifactId>
  73             <scope>provided</scope>
  74         </dependency>
  75         <dependency>
  76             <groupId>org.mockito</groupId>
  77             <artifactId>mockito-core</artifactId>
  78             <scope>provided</scope>
  79         </dependency>
  80         <dependency>
  81             <groupId>org.osgi</groupId>
  82             <artifactId>org.osgi.annotation.versioning</artifactId>
  83         </dependency>
  84         <dependency>
  85             <groupId>org.osgi</groupId>
  86             <artifactId>org.osgi.annotation.bundle</artifactId>
  87         </dependency>
  88         <dependency>
  89             <groupId>org.sonatype.plexus</groupId>
  90             <artifactId>plexus-build-api</artifactId>
  91             <scope>provided</scope>
  92         </dependency>
  93         <dependency>
  94             <groupId>org.ops4j.pax.exam</groupId>
  95             <artifactId>pax-exam</artifactId>
  96             <scope>provided</scope>
  97         </dependency>
  98         <dependency>
  99             <groupId>org.ops4j.pax.exam</groupId>
 100             <artifactId>pax-exam-junit4</artifactId>
 101             <scope>provided</scope>
 102         </dependency>
 103         <dependency>
 104             <groupId>org.ops4j.pax.exam</groupId>
 105             <artifactId>pax-exam-container-karaf</artifactId>
 106             <scope>provided</scope>
 107         </dependency>
 108         <dependency>
 109             <groupId>org.ops4j.pax.url</groupId>
 110             <artifactId>pax-url-aether</artifactId>
 111             <scope>provided</scope>
 112         </dependency>
 113         <dependency>
 114             <groupId>org.apache.karaf.bundle</groupId>
 115             <artifactId>org.apache.karaf.bundle.core</artifactId>
 116             <version>${karaf.version}</version>
 117             <scope>provided</scope>
 118         </dependency>
 119         <dependency>
 120             <groupId>jakarta.xml.bind</groupId>
 121             <artifactId>jakarta.xml.bind-api</artifactId>
 122             <scope>provided</scope>
 123         </dependency>
 124         <dependency>
 125             <groupId>org.eclipse.jdt</groupId>
 126             <artifactId>org.eclipse.jdt.annotation</artifactId>
 127             <scope>provided</scope>
 128         </dependency>
 129         <dependency>
 130             <groupId>com.github.spotbugs</groupId>
 131             <artifactId>spotbugs-annotations</artifactId>
 132             <scope>provided</scope>
 133         </dependency>
 134     </dependencies>
 135
 136     <build>
 137         <plugins>
 138             <plugin>
 139                 <groupId>org.asciidoctor</groupId>
 140                 <artifactId>asciidoctor-maven-plugin</artifactId>
 141                 <version>1.5.7.1</version>
 142                 <executions>
 143                     <execution>
 144                         <id>output-html</id>
 145                         <phase>generate-resources</phase>
 146                         <goals>
 147                             <goal>process-asciidoc</goal>
 148                         </goals>
 149                         <configuration>
 150                             <sourceHighlighter>coderay</sourceHighlighter>
 151                             <backend>html</backend>
 152                             <attributes>
 153                                 <toc/>
 154                                 <linkcss>false</linkcss>
 155                             </attributes>
 156                         </configuration>
 157                     </execution>
 158                 </executions>
 159                 <configuration>
 160                     <attributes>
 161                         <revnumber>${project.version}</revnumber>
 162                         <revdate>${maven.build.timestamp}</revdate>
 163                         <organization>${project.organization.name}</organization>
 164                     </attributes>
 165                 </configuration>
 166             </plugin>
 167
 168             <plugin>
 169                 <artifactId>maven-dependency-plugin</artifactId>
 170                 <executions>
 171                     <execution>
 172                         <id>unpack-sources</id>
 173                         <phase>process-classes</phase>
 174                         <goals>
 175                             <goal>unpack-dependencies</goal>
 176                         </goals>
 177                         <configuration>
 178                             <silent>true</silent>
 179                             <classifier>sources</classifier>
 180                             <includes>org/opendaylight/**</includes>
 181                             <includeGroupIds>org.opendaylight.odlparent</includeGroupIds>
 182                             <outputDirectory>${project.build.directory}/src</outputDirectory>
 183                         </configuration>
 184                     </execution>
 185                 </executions>
 186             </plugin>
 187             <plugin>
 188                 <groupId>org.codehaus.mojo</groupId>
 189                 <artifactId>build-helper-maven-plugin</artifactId>
 190                 <executions>
 191                     <execution>
 192                         <id>add-source</id>
 193                         <phase>process-classes</phase>
 194                         <goals>
 195                             <goal>add-source</goal>
 196                         </goals>
 197                         <configuration>
 198                             <sources>
 199                                 <source>${project.build.directory}/src</source>
 200                             </sources>
 201                         </configuration>
 202                     </execution>
 203                 </executions>
 204             </plugin>
 205
 206             <plugin>
 207                 <artifactId>maven-source-plugin</artifactId>
 208                 <executions>
 209                     <execution>
 210                         <id>attach-sources</id>
 211                         <!-- prepare-package so we build the source package before javadoc -->
 212                         <phase>prepare-package</phase>
 213                         <goals>
 214                             <goal>jar-no-fork</goal>
 215                         </goals>
 216                     </execution>
 217                 </executions>
 218             </plugin>
 219
 220             <plugin>
 221                 <artifactId>maven-javadoc-plugin</artifactId>
 222                 <executions>
 223                     <execution>
 224                         <id>attach-javadocs</id>
 225                         <goals>
 226                             <goal>jar</goal>
 227                         </goals>
 228                     </execution>
 229                 </executions>
 230
 231                 <configuration combine.children="append">
 232                     <!-- FIXME: remove this section once we can activate javadoc-links profile -->
 233                     <links>
 234                         <link>https://junit.org/junit4/javadoc/4.13/</link>
 235                         <link>http://hamcrest.org/JavaHamcrest/javadoc/2.2/</link>
 236                         <link>https://www.slf4j.org/apidocs/</link>
 237                         <link>https://google.github.io/guava/releases/31.1-jre/api/docs/</link>
 238                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-release/</link>
 239                     </links>
 240
 241                     <!-- FIXME: finish up -->
 242                     <doclint>all,-missing</doclint>
 243                     <groups>
 244                         <group>
 245                             <title>Bundle Test Library</title>
 246                             <packages>org.opendaylight.odlparent.bundlestest.lib*</packages>
 247                         </group>
 248                         <group>
 249                             <title>Single Feature Test</title>
 250                             <packages>org.opendaylight.odlparent.featuretest*</packages>
 251                         </group>
 252                         <group>
 253                             <title>Karaf Utilities</title>
 254                             <packages>org.opendaylight.odlparent.karafutil*</packages>
 255                         </group>
 256                         <group>
 257                             <title>Filter Manifest Maven Plugin</title>
 258                             <packages>org.opendaylight.odlparent.filter.manifest.plugin*</packages>
 259                         </group>
 260                     </groups>
 261                 </configuration>
 262             </plugin>
 263         </plugins>
 264     </build>
 265 </project>