This is an automated email from the ASF dual-hosted git repository.
ppalaga pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
commit 2b0fd99beaf65e29104a968d86cd3ea45908cf52
Author: Peter Palaga <ppal...@redhat.com>
AuthorDate: Mon May 25 12:12:53 2020 +0200
Make sure all extensions present in the List of extensions page have an
extension page
---
.../ROOT/pages/extensions/caffeine-lrucache.adoc | 22 ++++++++++++
.../extensions/microprofile-fault-tolerance.adoc | 28 +++++++++++++++
.../pages/list-of-camel-quarkus-extensions.adoc | 4 +--
extensions-core/caffeine-lrucache/runtime/pom.xml | 11 ++++++
.../microprofile-fault-tolerance/runtime/pom.xml | 11 ++++++
.../quarkus/maven/UpdateDocExtensionsListMojo.java | 41 ++++++++--------------
6 files changed, 89 insertions(+), 28 deletions(-)
diff --git a/docs/modules/ROOT/pages/extensions/caffeine-lrucache.adoc
b/docs/modules/ROOT/pages/extensions/caffeine-lrucache.adoc
new file mode 100644
index 0000000..2c089b9
--- /dev/null
+++ b/docs/modules/ROOT/pages/extensions/caffeine-lrucache.adoc
@@ -0,0 +1,22 @@
+// Do not edit directly!
+// This file was generated by
camel-quarkus-package-maven-plugin:update-extension-doc-page
+
+[[caffeine-lrucache]]
+= Caffeine LRUCache
+
+[.badges]
+[.badge-key]##Since Camel Quarkus##[.badge-version]##1.0.0-M5##
[.badge-key]##JVM##[.badge-supported]##supported##
[.badge-key]##Native##[.badge-supported]##supported##
+
+An LRUCacheFactory implementation based on Caffeine
+
+== Maven coordinates
+
+[source,xml]
+----
+<dependency>
+ <groupId>org.apache.camel.quarkus</groupId>
+ <artifactId>camel-quarkus-caffeine-lrucache</artifactId>
+</dependency>
+----
+
+Check the xref:user-guide/index.adoc[User guide] for more information about
writing Camel Quarkus applications.
diff --git
a/docs/modules/ROOT/pages/extensions/microprofile-fault-tolerance.adoc
b/docs/modules/ROOT/pages/extensions/microprofile-fault-tolerance.adoc
new file mode 100644
index 0000000..bc9d3b4
--- /dev/null
+++ b/docs/modules/ROOT/pages/extensions/microprofile-fault-tolerance.adoc
@@ -0,0 +1,28 @@
+// Do not edit directly!
+// This file was generated by
camel-quarkus-package-maven-plugin:update-extension-doc-page
+
+[[microprofile-fault-tolerance]]
+= Microprofile Fault Tolerance
+
+[.badges]
+[.badge-key]##Since Camel Quarkus##[.badge-version]##1.0.0-M8##
[.badge-key]##JVM##[.badge-supported]##supported##
[.badge-key]##Native##[.badge-supported]##supported##
+
+Circuit Breaker EIP using Microprofile Fault Tolerance
+
+== What's inside
+
+*
https://camel.apache.org/components/latest/others/microprofile-fault-tolerance.html[Microprofile
Fault Tolerance]
+
+Please refer to the above link for usage and configuration details.
+
+== Maven coordinates
+
+[source,xml]
+----
+<dependency>
+ <groupId>org.apache.camel.quarkus</groupId>
+ <artifactId>camel-quarkus-microprofile-fault-tolerance</artifactId>
+</dependency>
+----
+
+Check the xref:user-guide/index.adoc[User guide] for more information about
writing Camel Quarkus applications.
diff --git a/docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc
b/docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc
index 635dfca..174d08a 100644
--- a/docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc
+++ b/docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc
@@ -773,7 +773,7 @@ Number of miscellaneous extensions: 13 in 13 JAR artifacts
(0 deprecated)
| xref:extensions/attachments.adoc[camel-quarkus-attachments] | Native +
Stable | 0.3.0 | Java Attachments support for Camel Message
-| (camel-quarkus-caffeine-lrucache) | Native +
+| xref:extensions/caffeine-lrucache.adoc[camel-quarkus-caffeine-lrucache] |
Native +
Stable | 1.0.0-M5 | An LRUCacheFactory implementation based on Caffeine
| xref:extensions/core-cloud.adoc[camel-quarkus-core-cloud] | Native +
@@ -788,7 +788,7 @@ Number of miscellaneous extensions: 13 in 13 JAR artifacts
(0 deprecated)
| xref:extensions/kotlin.adoc[camel-quarkus-kotlin] | Native +
Stable | 1.0.0-M3 | Write Camel integration routes in Kotlin
-| (camel-quarkus-microprofile-fault-tolerance) | Native +
+|
xref:extensions/microprofile-fault-tolerance.adoc[camel-quarkus-microprofile-fault-tolerance]
| Native +
Stable | 1.0.0-M8 | Circuit Breaker EIP using Microprofile Fault Tolerance
| xref:extensions/microprofile-health.adoc[camel-quarkus-microprofile-health]
| Native +
diff --git a/extensions-core/caffeine-lrucache/runtime/pom.xml
b/extensions-core/caffeine-lrucache/runtime/pom.xml
index e3eb8b3..f3d7da0 100644
--- a/extensions-core/caffeine-lrucache/runtime/pom.xml
+++ b/extensions-core/caffeine-lrucache/runtime/pom.xml
@@ -53,6 +53,17 @@
<build>
<plugins>
<plugin>
+ <groupId>org.apache.camel.quarkus</groupId>
+ <artifactId>camel-quarkus-package-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>update-extension-doc-page</id>
+ <goals><goal>update-extension-doc-page</goal></goals>
+ <phase>process-resources</phase>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-bootstrap-maven-plugin</artifactId>
<version>${quarkus.version}</version>
diff --git a/extensions/microprofile-fault-tolerance/runtime/pom.xml
b/extensions/microprofile-fault-tolerance/runtime/pom.xml
index a0eb528..e3e3a79 100644
--- a/extensions/microprofile-fault-tolerance/runtime/pom.xml
+++ b/extensions/microprofile-fault-tolerance/runtime/pom.xml
@@ -66,6 +66,17 @@
<build>
<plugins>
<plugin>
+ <groupId>org.apache.camel.quarkus</groupId>
+ <artifactId>camel-quarkus-package-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>update-extension-doc-page</id>
+ <goals><goal>update-extension-doc-page</goal></goals>
+ <phase>process-resources</phase>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-bootstrap-maven-plugin</artifactId>
</plugin>
diff --git
a/tooling/package-maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateDocExtensionsListMojo.java
b/tooling/package-maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateDocExtensionsListMojo.java
index 7b9078b..58c4ea0 100644
---
a/tooling/package-maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateDocExtensionsListMojo.java
+++
b/tooling/package-maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateDocExtensionsListMojo.java
@@ -34,7 +34,6 @@ import freemarker.template.Configuration;
import freemarker.template.TemplateMethodModelEx;
import freemarker.template.TemplateModelException;
import freemarker.template.utility.DeepUnwrap;
-import org.apache.camel.catalog.Kind;
import org.apache.camel.tooling.model.ArtifactModel;
import org.apache.camel.tooling.model.BaseModel;
import org.apache.camel.tooling.model.ComponentModel;
@@ -48,7 +47,7 @@ import org.apache.maven.plugins.annotations.Parameter;
import static java.util.stream.Collectors.toSet;
/**
- * Updates the documentation in:
+ * Updates the lists of components, data formats,
*
* - docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc
*
@@ -90,7 +89,7 @@ public class UpdateDocExtensionsListMojo extends
AbstractDocGeneratorMojo {
} catch (IOException e) {
throw new RuntimeException("Could not read " + extensionListPath,
e);
}
- final GetDocLink getDocLink = new
GetDocLink(extensionListPath.getParent().resolve("extensions"));
+ final GetDocLink getDocLink = new
GetDocLink(extensionListPath.getParent().resolve("extensions"),
extensionListPath);
final TemplateMethodModelEx getSupportLevel = new
TemplateMethodModelEx() {
@Override
public Object exec(List arguments) throws TemplateModelException {
@@ -178,40 +177,30 @@ public class UpdateDocExtensionsListMojo extends
AbstractDocGeneratorMojo {
static class GetDocLink implements TemplateMethodModelEx {
private final Path extensionsDocPath;
+ private final Path extensionListPath;
- public GetDocLink(Path extensionsDocPath) {
+ public GetDocLink(Path extensionsDocPath, Path extensionListPath) {
super();
this.extensionsDocPath = extensionsDocPath;
+ this.extensionListPath = extensionListPath;
}
@Override
public Object exec(List arguments) throws TemplateModelException {
if (arguments.size() != 1) {
- throw new TemplateModelException("Wrong argument count in
toCamelCase()");
+ throw new TemplateModelException("Expected one argument for
getDocLink(); found " + arguments.size());
}
ArtifactModel<?> model = (ArtifactModel<?>)
DeepUnwrap.unwrap((StringModel) arguments.get(0));
- if (localDocExists(model)) {
- return getLocalDocLink(model);
- } else if (Kind.other.name().equals(model.getKind())) {
- return null;
- } else {
- return
String.format("link:https://camel.apache.org/components/latest/%s-%s.html";,
- model.getName(),
- model.getKind());
+ final String artifactIdBase = CqUtils.getArtifactIdBase(model);
+ final String extensionPageName = artifactIdBase + ".adoc";
+ final Path extensionPagePath =
extensionsDocPath.resolve(extensionPageName);
+ if (!Files.exists(extensionPagePath)) {
+ throw new IllegalStateException(
+ "File " + extensionPagePath + " must exist to be able
to refer to it from " + extensionListPath
+ + ".\nYou may need to add\n\n
org.apache.camel.quarkus:camel-quarkus-package-maven-plugin:update-extension-doc-page\n\nmojo
in "
+ + artifactIdBase + " runtime module");
}
- }
-
- private boolean localDocExists(ArtifactModel<?> model) {
- final Path path =
extensionsDocPath.resolve(getExtensionDocName(model));
- return path.toFile().exists();
- }
-
- private String getLocalDocLink(ArtifactModel<?> model) {
- return "xref:extensions/" + getExtensionDocName(model);
- }
-
- private String getExtensionDocName(ArtifactModel<?> model) {
- return CqUtils.getArtifactIdBase(model) + ".adoc";
+ return "xref:extensions/" + extensionPageName;
}
}
