Skip to content

Commit 92a9328

Browse files
committed
docs: add guidance for updating Java version in modules
Signed-off-by: Marvin Froeder <[email protected]>
1 parent ec30480 commit 92a9328

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

CLAUDE.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,29 @@ Feign is a declarative HTTP client library with a modular design:
7878
### Java Version Support
7979
- Source/target: Java 8 (for `src/main`)
8080
- Tests: Java 21 (for `src/test`)
81-
- Maintains backwards compatibility with Java 8 in main codebase
81+
- Maintains backwards compatibility with Java 8 in main codebase
82+
83+
### Updating Java Version for a Module
84+
When a module's dependencies require a newer Java version (e.g., due to dependency upgrades), you need to override the Java version in that module's `pom.xml`:
85+
86+
1. Add a `<properties>` section to the module's `pom.xml` (or update existing one)
87+
2. Set `<main.java.version>` to the required version (11, 17, 21, etc.)
88+
89+
Example:
90+
```xml
91+
<properties>
92+
<main.java.version>17</main.java.version>
93+
</properties>
94+
```
95+
96+
**Common scenarios requiring Java version updates:**
97+
- Dropwizard Metrics 5.x requires Java 17
98+
- Handlebars 4.5.0+ requires Java 17
99+
- Jakarta EE modules typically require Java 11+
100+
101+
**Examples of modules with custom Java versions:**
102+
- `spring/` - Java 17 (for Spring 6.x)
103+
- `jaxrs4/` - Java 17 (for Jakarta EE 9+)
104+
- `dropwizard-metrics5/` - Java 17 (for Metrics 5.x)
105+
- `apt-test-generator/` - Java 17 (for Handlebars 4.5.0+)
106+
- `soap-jakarta/`, `jaxb-jakarta/` - Java 11 (for Jakarta namespace)

0 commit comments

Comments
 (0)