Keycloak-client java modules
The files in the modules:
are not "owned" by this repository and hence the Java files should ideally not be directly updated. Those files are "owned" by the main Keycloak server repository and hence are supposed to be updated there (whenever needed) and synced into this repository by the bash script sync-keycloak-sources.sh
Note
client-common-synced module will be synced from Keycloak Main repository for the future and is a dependency of rest of the modules in this repository. Modules admin-client and authz-client may move to this repository in the future, therefore they are separated.
-
Fetch main Keycloak server repository and checkout the last
release/X.Ybranch (For examplegit checkout release/26.0). Note that we usually cannot sync from the servermainbranch as it is under development and there is still a chance that some things being developed here would be later updated/removed. Which could be an issue as for client, we want to preserve backwards compatibility. -
build it on your laptop to make sure latest Keycloak stuff available in your local maven repository.
-
Send PR with the changes to update corresponding branch (usually
main) of Keycloak client repository
mvn clean install -DskipTests=true
cd testsuite
mvn clean install
By default testsuite starts Keycloak server inside docker image, which is based on testcontainers. So it uses white-box testing from the point of view of the Keycloak server.
When running with the argument keycloak.lifecycle like:
mvn clean install -Dkeycloak.lifecycle=remote
The testsuite won't start the Keycloak server, but instead tests will try to use Keycloak server, which is already started on this laptop where testsuite is running.
It is also possible to use different version of Keycloak server. By default, it uses nightly docker image, but can be overriden by the parameter like this:
mvn clean install -Dkeycloak.version.docker.image=24.0