Releasing a new version

We will release a new version of Keycloak Benchmark when we have one or more breaking backward compatibility changes with prior versions of Keycloak releases. The changes are often in the "dataset" provider but are not limited to that.

Release steps

  1. Make sure that everything needed is committed and pushed to the main branch of Keycloak Benchmark.

  2. Copy the full commit SHA that should be the last commit in the release branch.

  3. Open the Create release branch workflow in GitHub Actions and select Run workflow.

  4. Enter the full source commit SHA and the Benchmark release version, for example 26.6.0.

  5. Review the workflow output and the created branch and snapshot release.

The workflow selects the latest stable Keycloak patch release matching the release line. For example, a 26.6.0 Benchmark release uses the latest available 26.6.x Keycloak release. It independently selects the latest stable Keycloak Java client release for the same major version.

The workflow creates a branch named <major>.<minor>-release, updates and validates the release-specific versions, and runs a full local Maven build. Only after the build succeeds, it creates a signed-off preparation commit and pushes the release branch. The existing Snapshot Release workflow then creates the <release-version>-SNAPSHOT tag and artifacts.

To inspect the changes locally without creating or pushing a branch or tag, run:

scripts/create-release-branch.sh \
  --source <full-main-commit-sha> \
  --release 26.6.0

The automatically selected Keycloak server and client versions can be overridden locally with --keycloak-version and --keycloak-client-version when a released version has a known regression.