Maintenance instructions for fork - Nordix/keycloak GitHub Wiki

Maintenance instructions for fork

Creating new release track

Create new branch off from the base upstream tag

git checkout 24.0.4
git checkout -b 24.0.4-nordix

Check the list of patches that will be still needed based on the list of patches that were in previous branch

git log 22.0.5-nordix

Start to apply them from oldest to the newest

git cherry-pick 8971df69c719b64bf30006cbf5fd4d63cfbb4f79

Sort out merge conflicts by carefully comparing the changes in the new base branch and the old base branch vs the change being cherry-picked. Compile and try to run minimal tests to before completing each cherry-pick.

Depending on Keycloak version, pick older JDK version

sdk use java 17.0.12-tem

# ldap federation tests
mvn clean install -DskipTests
mvn install -f testsuite/integration-arquillian/pom.xml -Dtest=org.keycloak.testsuite.federation.ldap.** -Dkeycloak.logging.level=debug
mvn install -f testsuite/integration-arquillian/pom.xml -Dtest=org.keycloak.testsuite.admin.UserFederationLdapConnectionTest

Test in org.keycloak.testsuite.federation.ldap.** group has these re-producible failures when running locally (reason not known)

[INFO] Results:
[INFO]
[ERROR] Failures:
[ERROR]   LDAPProvidersIntegrationTest.testSyncRegistrationEmailRDNNoDefault:218 expected:<400> but was:<500>
[ERROR]   LDAPProvidersIntegrationNoImportTest>LDAPProvidersIntegrationTest.testSyncRegistrationEmailRDNNoDefault:218 expected:<400> but was:<500>
[ERROR] Errors:
[ERROR]   LDAPAdminRestApiTest.testErrorResponseWhenLdapIsFailing:258 » Processing com.fasterxml.jackson.core.JsonParseException: Unrecognized token 'Not': was expecting (JSON String, Number, Array, Object or token 'null', 'true' or 'false')
 at [Source: REDACTED (`StreamReadFeature.INCLUDE_SOURCE_IN_LOCATION` disabled); line: 1, column: 5]
[INFO]
[ERROR] Tests run: 231, Failures: 2, Errors: 1, Skipped: 9
[INFO]

Create a release

  1. Go to https://github.com/Nordix/keycloak/releases and click "Draft a new release".
  2. Click "Choose a tag" and write a new tag, for example 26.0.0-nordix-1 and click "Create new tag" in the popup
  3. Choose target branch for the tag, for example "26.0.0-nordix"
  4. Click "Generate release notes" to get the commit/change link Note that link like https://github.com/Nordix/keycloak/compare/26.0.0...26.0.0-nordix-1 will not work before tag 26.0.0-nordix-1 has been published
  5. Use release notes from some earlier release as template
  6. Click "Publish release"
⚠️ **GitHub.com Fallback** ⚠️