From ea817de3d4a5eb49306edf78712633515fc1040b Mon Sep 17 00:00:00 2001 From: Matus Marko Date: Thu, 1 Oct 2026 10:16:59 +0300 Subject: [PATCH 1/2] IS-11744 Document the branching model for consumers. Co-Authored-By: Claude Opus 5.5 --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index eb0db74e..30355ecf 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,20 @@ This monorepo contains: - UI Icons React Library - React Component Library +## Branches and releases + +`main` is the development branch. It holds the work for the next release and does **not** correspond to any released version. It previously mirrored the latest release; that is no longer the case. + +To work against a released version, check out the version branch for your Identity Server version: + +```shell +git checkout version/. +``` + +For example, for Identity Server 11.5.x, check out `version/11.5`. + +Version branches keep receiving fixes for their release after it ships, without picking up unreleased development work from `main`. Each release is also tagged as `ui-kit-` (for example `ui-kit-11.5.0`) if you need the exact state that shipped. Releases that have no version branch are available through their tag only. + ## Prerequisites - Node.js (version as specified in the `.nvmrc` file) From 368815c80ad2de73377c3e983cf877b4365be1fe Mon Sep 17 00:00:00 2001 From: Matus Marko Date: Thu, 1 Oct 2026 13:16:30 +0300 Subject: [PATCH 2/2] IS-11744 Address review comments. Co-Authored-By: Claude Opus 5.5 --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 30355ecf..3777679a 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,15 @@ This monorepo contains: ## Branches and releases -`main` is the development branch. It holds the work for the next release and does **not** correspond to any released version. It previously mirrored the latest release; that is no longer the case. +`main` is the development branch. It holds the work for the next release and does **not** correspond to any released version. + +> [!NOTE] +> Before the 11.5 release, `main` reflected the latest release. That is no longer the case. To work against a released version, check out the version branch for your Identity Server version: ```shell -git checkout version/. +git checkout version/X.Y ``` For example, for Identity Server 11.5.x, check out `version/11.5`.