Skip to content

Commit 492264e

Browse files
authored
doc(java-generator): document <dependencies> in pom.xml example
1 parent eaf7cff commit 492264e

File tree

2 files changed

+48
-16
lines changed

2 files changed

+48
-16
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
#### Improvements
88
* Fix #5878: (java-generator) Add implements Editable for extraAnnotations
9+
* Fix #5878: (java-generator) Update documentation to include dependencies
910

1011
#### Dependency Upgrade
1112

doc/java-generation-from-CRD.md

Lines changed: 47 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,53 @@ jbang io.fabric8:java-generator-cli:<version>
3030
The Java generator Maven plugin can be used from your project `pom.xml` adding a section like:
3131

3232
```xml
33-
<plugin>
34-
<groupId>io.fabric8</groupId>
35-
<artifactId>java-generator-maven-plugin</artifactId>
36-
<version>${kubernetes-client.version}</version>
37-
<executions>
38-
<execution>
39-
<goals>
40-
<goal>generate</goal>
41-
</goals>
42-
</execution>
43-
</executions>
44-
<configuration>
45-
<source>src/main/resources/kubernetes</source>
46-
...
47-
</configuration>
48-
</plugin>
33+
<dependencies>
34+
<dependency>
35+
<groupId>io.fabric8</groupId>
36+
<artifactId>kubernetes-client</artifactId>
37+
<version>${kubernetes-client.version}</version>
38+
</dependency>
39+
<dependency>
40+
<groupId>io.fabric8</groupId>
41+
<artifactId>generator-annotations</artifactId>
42+
<version>${kubernetes-client.version}</version>
43+
</dependency>
44+
45+
<!-- extraAnnotations requires these additional dependencies -->
46+
<dependency>
47+
<groupId>io.sundr</groupId>
48+
<artifactId>builder-annotations</artifactId>
49+
<version>${sundrio.version}</version>
50+
<scope>provided</scope>
51+
</dependency>
52+
<dependency>
53+
<groupId>org.projectlombok</groupId>
54+
<artifactId>lombok</artifactId>
55+
<version>${lombok.version}</version>
56+
<scope>provided</scope>
57+
</dependency>
58+
</dependencies>
59+
60+
<build>
61+
<plugins>
62+
<plugin>
63+
<groupId>io.fabric8</groupId>
64+
<artifactId>java-generator-maven-plugin</artifactId>
65+
<version>${kubernetes-client.version}</version>
66+
<executions>
67+
<execution>
68+
<goals>
69+
<goal>generate</goal>
70+
</goals>
71+
</execution>
72+
</executions>
73+
<configuration>
74+
<source>src/main/resources/kubernetes</source>
75+
<!-- .. .-->
76+
</configuration>
77+
</plugin>
78+
</plugins>
79+
</build>
4980
```
5081

5182
## Quick start Gradle

0 commit comments

Comments
 (0)