Skip to content

Commit f91341f

Browse files
committed
Bump readme and security files
1 parent 987584f commit f91341f

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
![Java 11+](https://img.shields.io/badge/Java-11--24-brown?logo=openjdk&logoColor=white)
1+
![Java 11+](https://img.shields.io/badge/V4-jdk11%2B-green?logo=openjdk&logoColor=white)
2+
![Java 17+](https://img.shields.io/badge/V5-jdk17%2B-blue?logo=openjdk&logoColor=white)
23
[![Build Status](https://github.com/ascopes/java-compiler-testing/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/ascopes/java-compiler-testing/actions/workflows/build.yml)
34
[![Maven Central](https://img.shields.io/maven-central/v/io.github.ascopes.jct/java-compiler-testing)](https://repo1.maven.org/maven2/io/github/ascopes/jct/java-compiler-testing)
45
[![Code Coverage](https://codecov.io/gh/ascopes/java-compiler-testing/branch/main/graph/badge.svg?token=VT74BP2742)](https://codecov.io/gh/ascopes/java-compiler-testing)
@@ -85,6 +86,12 @@ dependencies {
8586
}
8687
```
8788

89+
For Java 11 support, you should use the v4.x version of this library. If you
90+
only need to build on Java 17 or newer, you should use the v5.x version of this
91+
library. This does not affect the versions of Java you can write tests to cross
92+
compile against, but affects the versions of various dependencies and the
93+
bytecode version of this library itself.
94+
8895
## JPMS
8996

9097
If your tests make use of JPMS (i.e. they have a `module-info.java` somewhere), then you will want
@@ -229,8 +236,9 @@ support, running the Lombok annotation processor over the input. This assumes th
229236
JAR is already on the classpath for the JUnit test runner (e.g. is a test dependency in your
230237
project).
231238

232-
You will want to make sure you do not attempt to target anything older than Java 9 in this case, since
233-
module support was only introduced in Java 9.
239+
> [!IMPORTANT]
240+
> You will want to make sure you do not attempt to target anything older than Java 9 in this case, since
241+
> module support was only introduced in Java 9.
234242
235243
```java
236244

@@ -330,9 +338,7 @@ holding the flags you wish to use.
330338
`-XX:+TieredCompilation -XX:TieredStopAtLevel=1` to set this up. Enabling this in the JCT
331339
builds reduced the overall build time by around 20 seconds.
332340
2. Use the ZGC - the ZGC will reduce lag when performing garbage collection on code that
333-
has a high churn of objects. On Java 11, the ZGC is an experimental feature, which needs
334-
to be enabled with `-XX:+UnlockExperimentalOptions -XX:+UseZGC`. On Java 17, you just
335-
need to pass `-XX:+UseZGC` alone.
341+
has a high churn of objects. You just need to pass `-XX:+UseZGC` alone.
336342

337343
## Third-party compiler support
338344

SECURITY.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ significant impact. However, should an issue be identified, I
77
will strive to fix these issues as soon as possible.
88

99
Fixes will be released as a new version, built from the most
10-
recent `main` branch. Unless expressly requested, no attempt
11-
to backport changes will be made.
10+
recent `main` branch for Java 17, and from the v4 branch for
11+
Java 11 backwards compatibility. Unless expressly requested,
12+
no attempt to backport changes will be made.
1213

1314
Given this library is designed for use in test packs, the main
1415
design assumption is that the software is being used by a

0 commit comments

Comments
 (0)