jlengrand/helidon
1
0
Fork 0
mirror of https://github.com/jlengrand/helidon.git synced 2026-03-10 08:21:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix Java API links in Javadocs (#184)

Browse Source 
* Fix Java API links in Javadocs
Increase timeout in wercker pipeline jobs.

* forgot to replace a few more occurences to java.version property
This commit is contained in:
Romain Grecourt
2018-11-15 13:09:59 -08:00
committed by GitHub
parent 804408e153
commit b98b0b7302
4 changed files with 116 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
javadocs/README.md
View File

@@ -5,8 +5,10 @@ Aggregated javadocs for the Helidon Components.
## Requirements
The Maven `sources.jar` are required to aggregate the javadocs.
When building locally against SNAPSHOT, you can generate the `source.jar` for all
components by doing a top level build with `-Psources`.
When building locally against SNAPSHOT, you can generate the `sources.jar` for
all components by doing a top level build with `-Psources`.
## Building the javadocs
```bash
# Cd to the project root

168
javadocs/pom.xml
View File

@@ -37,6 +37,13 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<!-- skip the execution added by the javadoc profile -->
<execution>
<id>default-jar</id>
<configuration>
<skip>true</skip>
</configuration>
</execution>
<execution>
<id>javadoc</id>
<phase>generate-sources</phase>
@@ -94,21 +101,6 @@
</groups>
<includeDependencySources>true</includeDependencySources>
<includeTransitiveDependencySources>true</includeTransitiveDependencySources>
<links>
<link>http://docs.jboss.org/cdi/api/${version.lib.cdi-api}</link>
<link>http://www.reactive-streams.org/reactive-streams-${version.lib.reactivestreams}-javadoc</link>
<link>https://jax-rs.github.io/apidocs/${version.lib.jaxrs-api}</link>
<link>https://jersey.github.io/apidocs/${version.lib.jersey}/jersey</link>
<link>https://static.javadoc.io/com.typesafe/config/${version.lib.typesafe-config}</link>
<link>https://static.javadoc.io/io.netty/netty-transport/${version.lib.netty}</link>
<link>https://static.javadoc.io/io.opentracing/opentracing-api/${version.lib.opentracing}</link>
<link>https://static.javadoc.io/io.prometheus/simpleclient/${version.lib.prometheus}</link>
<link>https://static.javadoc.io/io.zipkin.reporter2/zipkin-reporter/${version.lib.zipkin}</link>
<link>https://static.javadoc.io/javax.json/javax.json-api/${version.lib.jsonp-api}</link>
<link>https://static.javadoc.io/org.eclipse.microprofile.config/microprofile-config-api/${version.lib.microprofile-config-api}</link>
<link>https://static.javadoc.io/org.eclipse.microprofile.health/microprofile-health-api/${version.lib.microprofile-health-api}</link>
<link>https://static.javadoc.io/org.eclipse.microprofile.metrics/microprofile-metrics-api/${version.lib.microprofile-metrics-api}</link>
</links>
<maxmemory>256m</maxmemory>
<reportOutputDirectory>${project.build.directory}</reportOutputDirectory>
<sourceFileExcludes>
@@ -125,203 +117,223 @@
</plugins>
</build>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>io.helidon</groupId>
<artifactId>helidon-bom</artifactId>
<version>${project.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>io.helidon.webserver</groupId>
<artifactId>helidon-webserver</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.webserver</groupId>
<artifactId>helidon-webserver-netty</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.webserver</groupId>
<artifactId>helidon-webserver-json</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.webserver</groupId>
<artifactId>helidon-webserver-zipkin</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.webserver</groupId>
<artifactId>helidon-webserver-prometheus</artifactId>
<version>${project.version}</version>
</dependency>
<!-- config -->
<dependency>
<groupId>io.helidon.config</groupId>
<artifactId>helidon-config-bundle</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.config</groupId>
<artifactId>helidon-config-etcd</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.config</groupId>
<artifactId>helidon-config-git</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.config</groupId>
<artifactId>helidon-config-testing</artifactId>
<version>${project.version}</version>
</dependency>
<!-- security -->
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-tools-config</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- Support for outbound security filtering -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-providers-common</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- Support for Google access token -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-provider-google-login</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-provider-jwt</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- Basic and digest authentication -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-provider-http-auth</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- Authentication provider supporting Signatures -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-provider-http-signature</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- Jersey integration -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-integration-jersey</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- Web server integration -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-integration-webserver</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- Integration annotations -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-integration-annotations</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- Attribute based access control support -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-provider-abac</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-abac-time</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-abac-role</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-abac-scope</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-abac-policy</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-abac-policy-el</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- JWT and JWK support -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-jwt</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<!-- A full-bundle except integrations with containers -->
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-bundle</artifactId>
<version>${project.version}</version>
</dependency>
<!-- microprofile -->
<dependency>
<groupId>io.helidon.microprofile.bundles</groupId>
<artifactId>helidon-microprofile-1.2</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.microprofile</groupId>
<artifactId>helidon-microprofile-security</artifactId>
</dependency>
<!-- integrations javadocs -->
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-api</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-config-source</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-hikaricp-accs</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-hikaricp-localhost</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-hikaricp</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-system-kubernetes</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-system-oracle-accs</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.integrations.cdi</groupId>
<artifactId>helidon-integrations-cdi-datasource-hikaricp</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.integrations.cdi</groupId>
<artifactId>helidon-integrations-cdi-jedis</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.integrations.cdi</groupId>
<artifactId>helidon-integrations-cdi-oci-objectstorage</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
<profiles>
<profile>
<id>integrations</id>
<dependencies>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-api</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-config-source</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-hikaricp-accs</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-hikaricp-localhost</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-hikaricp</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-system-kubernetes</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.serviceconfiguration</groupId>
<artifactId>helidon-serviceconfiguration-system-oracle-accs</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.integrations.cdi</groupId>
<artifactId>helidon-integrations-cdi-datasource-hikaricp</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.integrations.cdi</groupId>
<artifactId>helidon-integrations-cdi-jedis</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.helidon.integrations.cdi</groupId>
<artifactId>helidon-integrations-cdi-oci-objectstorage</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
</profile>
<profile>
<id>release</id>
<build>

30
pom.xml
View File

@@ -81,8 +81,6 @@
</scm>
<properties>
<java.version>8</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
@@ -117,7 +115,7 @@
<version.lib.guava>25.0-jre</version.lib.guava>
<version.lib.h2>1.4.197</version.lib.h2>
<version.lib.hamcrest>1.3</version.lib.hamcrest>
<version.lib.HikariCP>2.7.8</version.lib.HikariCP>
<version.lib.hikaricp>2.7.8</version.lib.hikaricp>
<version.lib.jackson>2.9.4</version.lib.jackson>
<version.lib.jandex>2.0.4.Final</version.lib.jandex>
<version.lib.jaxb-api>2.3.0</version.lib.jaxb-api>
@@ -215,8 +213,8 @@
<artifactId>maven-compiler-plugin</artifactId>
<version>${version.plugin.compiler}</version>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
<source>1.8</source>
<target>1.8</target>
<compilerArgs>
<arg>-Xlint:unchecked</arg>
</compilerArgs>
@@ -227,11 +225,25 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>${version.plugin.javadoc}</version>
<configuration>
<links>
<link>http://docs.jboss.org/cdi/api/${version.lib.cdi-api}</link>
<link>http://www.reactive-streams.org/reactive-streams-${version.lib.reactivestreams}-javadoc</link>
<link>https://jax-rs.github.io/apidocs/${version.lib.jaxrs-api}</link>
<link>https://jersey.github.io/apidocs/${version.lib.jersey}/jersey</link>
<link>https://static.javadoc.io/com.typesafe/config/${version.lib.typesafe-config}</link>
<link>https://static.javadoc.io/io.netty/netty-transport/${version.lib.netty}</link>
<link>https://static.javadoc.io/io.opentracing/opentracing-api/${version.lib.opentracing}</link>
<link>https://static.javadoc.io/io.prometheus/simpleclient/${version.lib.prometheus}</link>
<link>https://static.javadoc.io/io.zipkin.reporter2/zipkin-reporter/${version.lib.zipkin}</link>
<link>https://static.javadoc.io/javax.json/javax.json-api/${version.lib.jsonp-api}</link>
<link>https://static.javadoc.io/org.eclipse.microprofile.config/microprofile-config-api/${version.lib.microprofile-config-api}</link>
<link>https://static.javadoc.io/org.eclipse.microprofile.health/microprofile-health-api/${version.lib.microprofile-health-api}</link>
<link>https://static.javadoc.io/org.eclipse.microprofile.metrics/microprofile-metrics-api/${version.lib.microprofile-metrics-api}</link>
</links>
<doclint>all</doclint>
<additionalJOptions combine.children="append">
<JOption>-J-Dhttp.agent=maven-javadoc-plugin</JOption>
</additionalJOptions>
<source>8</source>
<sourceFileExcludes>
<sourceFileExclude>**/module-info.java</sourceFileExclude>
<sourceFileExclude>target/**/*.java</sourceFileExclude>
@@ -932,7 +944,7 @@
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>${version.lib.HikariCP}</version>
<version>${version.lib.hikaricp}</version>
</dependency>
<dependency>
<groupId>redis.clients</groupId>
@@ -1088,7 +1100,7 @@
<goal>compile</goal>
</goals>
<configuration>
<release>${java.version}</release>
<release>8</release>
</configuration>
</execution>
<execution>
@@ -1097,7 +1109,7 @@
<goal>testCompile</goal>
</goals>
<configuration>
<release>${java.version}</release>
<release>8</release>
</configuration>
</execution>
</executions>

1
wercker.yml
View File

@@ -15,6 +15,7 @@
#
box: maven:3.5.4-jdk-9
command-timeout: 60
copyright:
steps: