Skip to content

Commit 0cb7caa

Browse files
dasnikodasniko
committed
move version overview to separate file
Signed-off-by: Niko Köbler <niko@n-k.de>
1 parent 9c6f8c7 commit 0cb7caa

File tree

2 files changed

+72
-37
lines changed

2 files changed

+72
-37
lines changed

‎README.md‎

Lines changed: 12 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@ A [Testcontainers](https://www.testcontainers.org/) implementation for [Keycloak
1313
[![GitHub Stars](https://img.shields.io/github/stars/dasniko/testcontainers-keycloak)](https://github.com/dasniko/testcontainers-keycloak/stargazers)
1414
[![CI build](https://github.com/dasniko/testcontainers-keycloak/actions/workflows/maven.yml/badge.svg)](https://github.com/dasniko/testcontainers-keycloak/actions/workflows/maven.yml)
1515

16-
## IMPORTANT!!!
16+
## IMPORTANT!!! VERSIONS!!!
1717

18-
> This version branch (3.x) only handles Keycloak from version **22.x** and up, as there are major changes coming with this release (see the [blog post](https://www.keycloak.org/2023/07/keycloak-2200-released.html)).
19-
> See also [compatibility matrix](#testcontainers--keycloak-version-compatiblity).
20-
> For older Keycloak versions (until 21.x), see [version 2.x branch](https://github.com/dasniko/testcontainers-keycloak/tree/v2).
18+
> See [version overview](versions.md) for an overview which Keycloak release works with this library by default and which [Testcontainers](https://www.testcontainers.org/) version is used.
19+
> This library is, like Keycloak, only being developed in forward direction, there is no LTS, no backports, etc. available. So make sure to stay up to date.
2120
2221
## How to use
2322

@@ -301,15 +300,12 @@ In case you need a custom implementation of the default `KeycloakContainer`, you
301300

302301
```java
303302
public class MyCustomKeycloakContainer extends ExtendableKeycloakContainer<MyCustomKeycloakContainer> {
304-
305-
public MyCustomKeycloakContainer() {
306-
super();
307-
}
308-
309-
public MyCustomKeycloakContainer(String dockerImageName) {
310-
super(dockerImageName);
311-
}
312-
303+
public MyCustomKeycloakContainer() {
304+
super();
305+
}
306+
public MyCustomKeycloakContainer(String dockerImageName) {
307+
super(dockerImageName);
308+
}
313309
}
314310

315311
...
@@ -338,7 +334,7 @@ KeycloakContainer keycloak = new KeycloakContainer()
338334

339335
## Setup
340336

341-
The release versions of this project are available at [Maven Central](https://search.maven.org/artifact/com.github.dasniko/testcontainers-keycloak).
337+
The release versions of this project are available at [Maven Central](https://central.sonatype.com/artifact/com.github.dasniko/testcontainers-keycloak).
342338
Simply put the dependency coordinates to your `pom.xml` (or something similar, if you use e.g. Gradle or something else):
343339

344340
```xml
@@ -350,6 +346,8 @@ Simply put the dependency coordinates to your `pom.xml` (or something similar, i
350346
</dependency>
351347
```
352348

349+
For a version overview, see [here](versions.md).
350+
353351
> There is also a `999.0.0-SNAPSHOT` version available, pointing to `nightly` Docker image by default and using the `999.0.0-SNAPSHOT` Keycloak libraries as dependencies.
354352
355353
## Usage in your application framework tests
@@ -382,29 +380,6 @@ Consult the docs of your application framework testing capabilities on how to dy
382380
|---|---|
383381
| [![](http://img.youtube.com/vi/lBC51XZUM90/maxresdefault.jpg)](https://www.youtube.com/watch?v=lBC51XZUM90 "") |
384382

385-
386-
## Testcontainers & Keycloak version compatiblity
387-
388-
For Keycloak versions until 21.x, see [version 2.x branch](https://github.com/dasniko/testcontainers-keycloak/tree/v2)
389-
390-
| Testcontainers-Keycloak | Testcontainers | Keycloak |
391-
|-------------------------|----------------|----------|
392-
| 3.0.x | 1.18.3 | 22.0 |
393-
| 3.1.x | 1.18.3 | 22.0.5 |
394-
| 3.2.x | 1.19.3 | 23.0 |
395-
| 3.3.x | 1.19.6 | 24.0 |
396-
| 3.4.x | 1.19.8 | 25.0 |
397-
| 3.5.x | 1.20.2 | 26.0 |
398-
| 3.6.x | 1.20.4 | 26.1 |
399-
| 3.7.x | 1.20.6 | 26.2 |
400-
| 3.8.x | 1.21.3 | 26.3 |
401-
| 3.9.x | 1.21.3 | 26.4 |
402-
| 4.0.x | 2.0.2 | 26.4 |
403-
404-
_There might also be other possible version configurations which will work._
405-
406-
See also the [Releases](https://github.com/dasniko/testcontainers-keycloak/releases) page for version and feature update notes.
407-
408383
## Credits
409384

410385
Many thanks to the creators and maintainers of [Testcontainers](https://www.testcontainers.org/).

‎versions.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Keycloak Testcontainer Versions
2+
3+
## Testcontainers & Keycloak version compatibility
4+
5+
| Testcontainers-Keycloak | Testcontainers | Keycloak |
6+
|-------------------------|----------------|----------|
7+
| 4.0.x (Docker 29+) | 2.0.2 | 26.4 |
8+
| 3.9.x | 1.21.3 | 26.4 |
9+
| 3.8.x | 1.21.3 | 26.3 |
10+
| 3.7.x | 1.20.6 | 26.2 |
11+
| 3.6.x | 1.20.4 | 26.1 |
12+
| 3.5.x | 1.20.2 | 26.0 |
13+
| 3.4.x | 1.19.8 | 25.0 |
14+
| 3.3.x | 1.19.6 | 24.0 |
15+
| 3.2.x | 1.19.3 | 23.0 |
16+
| 3.1.x | 1.18.3 | 22.0.5 |
17+
| 3.0.x | 1.18.3 | 22.0 |
18+
| 2.6.0 | 1.18.3 | 22.0 |
19+
| 2.5.0 | 1.17.6 | 21.0 |
20+
| 2.4.0 | 1.17.3 | 20.0.0 |
21+
| 2.3.0 | 1.17.1 | 19.0.0 |
22+
| 2.2.2 | 1.17.1 | 18.0.0 |
23+
| 2.2.1 | 1.17.1 | 18.0.0 |
24+
| 2.2.0 | 1.17.1 | 18.0.0 |
25+
| 2.1.2 | 1.16.3 | 17.0.1 |
26+
| 2.1.1 | 1.16.3 | 17.0.0 |
27+
| 2.0.0 (Quarkus-based) | 1.16.3 | 17.0.0 |
28+
| 1.10.0 | 1.16.3 | 17.0.0 |
29+
| 1.9.0 | 1.16.2 | 16.0.0 |
30+
| 1.8.0 | 1.15.3 | 15.0.2 |
31+
| 1.7.1 | 1.15.3 | 13.0.1 |
32+
| 1.7.0 | 1.15.3 | 13.0.0 |
33+
| 1.6.1 | 1.15.1 | 12.0.4 |
34+
| 1.6.0 | 1.15.1 | 12.0.1 |
35+
| 1.5.0 | 1.15.1 | 12.0.1 |
36+
| 1.4.0 | 1.13.0 | 11.0.2 |
37+
| 1.3.3 | 1.13.0 | 10.0.2 |
38+
| 1.3.1 | 1.13.0 | 9.0.2 |
39+
| 1.3.0 | 1.12.3 | 8.0.1 |
40+
| 1.2.0 | 1.12.3 | 8.0.1 |
41+
42+
_There might also be other possible version configurations which will work._
43+
44+
See also the [Releases](https://github.com/dasniko/testcontainers-keycloak/releases) page for version and feature update notes.
45+
46+
## Public Repository
47+
48+
The release versions of this project are available at [Maven Central](https://central.sonatype.com/artifact/com.github.dasniko/testcontainers-keycloak).
49+
Simply put the dependency coordinates to your `pom.xml` (or something similar, if you use e.g. Gradle or something else):
50+
51+
```xml
52+
<dependency>
53+
<groupId>com.github.dasniko</groupId>
54+
<artifactId>testcontainers-keycloak</artifactId>
55+
<version>VERSION</version>
56+
<scope>test</scope>
57+
</dependency>
58+
```
59+
60+
There is also a `999.0.0-SNAPSHOT` version available, pointing to `nightly` Docker image by default and using the `999.0.0-SNAPSHOT` Keycloak libraries as dependencies.

0 commit comments

Comments
 (0)