doc(java-generator): document <dependencies> in pom.xml example

fabric8io · Apr 23, 2024 · 492264e · 492264e
1 parent eaf7cff
commit 492264e
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 
 #### Improvements
 * Fix #5878: (java-generator) Add implements Editable for extraAnnotations
+* Fix #5878: (java-generator) Update documentation to include dependencies
 
 #### Dependency Upgrade
 

diff --git a/doc/java-generation-from-CRD.md b/doc/java-generation-from-CRD.md
@@ -30,22 +30,53 @@ jbang io.fabric8:java-generator-cli:<version>
 The Java generator Maven plugin can be used from your project `pom.xml` adding a section like:
 
 ```xml
-<plugin>
-  <groupId>io.fabric8</groupId>
-  <artifactId>java-generator-maven-plugin</artifactId>
-  <version>${kubernetes-client.version}</version>
-  <executions>
-    <execution>
-      <goals>
-        <goal>generate</goal>
-      </goals>
-    </execution>
-  </executions>
-  <configuration>
-    <source>src/main/resources/kubernetes</source>
-    ...
-  </configuration>
-</plugin>
+  <dependencies>
+    <dependency>
+      <groupId>io.fabric8</groupId>
+      <artifactId>kubernetes-client</artifactId>
+      <version>${kubernetes-client.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>io.fabric8</groupId>
+      <artifactId>generator-annotations</artifactId>
+      <version>${kubernetes-client.version}</version>
+    </dependency>
+
+    <!-- extraAnnotations requires these additional dependencies -->
+    <dependency>
+      <groupId>io.sundr</groupId>
+      <artifactId>builder-annotations</artifactId>
+      <version>${sundrio.version}</version>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+      <version>${lombok.version}</version>
+      <scope>provided</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>io.fabric8</groupId>
+        <artifactId>java-generator-maven-plugin</artifactId>
+        <version>${kubernetes-client.version}</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <source>src/main/resources/kubernetes</source>
+          <!-- .. .-->
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
 ```
 
 ## Quick start Gradle