From 9d0bfa8208b34484e191b02ff67c442933170cf0 Mon Sep 17 00:00:00 2001 From: Thomas Darimont Date: Fri, 14 Jul 2023 14:13:58 +0200 Subject: [PATCH] Add Keycloak 22 - Keep backwards compatibility with Keycloak 18 / RH-SSO - Rewrite jakarta packages to javax packages before ci build for older Keycloak versions with maven-replacer-plugin - Use older resteasy version (4.7.7.Final) for Keycloak < 22.0.0 in ci - Add workaround to ResteasyUtil for missing isClose() method in older Resteasy JAX-RS Response type - Required jakarta dependencies - Make cookie handling in CookieClientFilter more robust - add generated master realm for 22.0.0 - Add missing mockServerClient request responder - Extend checkstyle config: Moved jakarta imports to SPECIAL import group that follows STANDARD_JAVA_PACKAGE import group - Adjusted realm setting internationalizationEnabled in test config files with is now required for managing user locale via attributes We need to configure internationalizationEnabled to be able to supply a locale attribute during user creation The enforcement was introduced in Keycloak 22.0.0, see: keycloak/keycloak@d0691b0 but the realm property exists for many years already and is thus safe to set. Fixes #897 --- .github/workflows/ci.yaml | 2 ++ CHANGELOG.md | 3 --- README.md | 5 +++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index d4406bf57..405f6bed6 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -27,6 +27,8 @@ jobs: fail-fast: false matrix: env: + # we keep 18.0.2 for backwards compatibility with RH-SSO 7.6 + - KEYCLOAK_VERSION: 18.0.2 - KEYCLOAK_VERSION: 19.0.3 - KEYCLOAK_VERSION: 20.0.5 - KEYCLOAK_VERSION: 21.1.1 diff --git a/CHANGELOG.md b/CHANGELOG.md index 7cc1e1887..a0ad14001 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,9 +14,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Migrated imports of javax packages to jakarta packages - Upgraded Spring Boot to 2.7.13 -### Removed -- Support for Keycloak 18 - ## [5.7.0] - 2023-07-14 ### Changed diff --git a/README.md b/README.md index 3f993ece0..3e8bed06a 100644 --- a/README.md +++ b/README.md @@ -77,9 +77,10 @@ See: [docs/FEATURES.md](./docs/FEATURES.md) # Compatibility with keycloak Since keycloak-config-cli 4.0 will support the latest 4 releases of keycloak, if possible. +There are some exceptions: -There are some exceptions, for example if keycloak introduce some backward compatible changes, keycloak-config-cli will cut the support, too. - +- keycloak-config-cli will try the keep an extended support for [RH-SSO](https://access.redhat.com/articles/2342881) +- keycloak-config-cli will cut the support if keycloak introduces some breaking changes # Build this project