Skip to content

IS-11744 Document the branching model for consumers #347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markoweb merged 2 commits into from
Oct 1, 2026
Merged

IS-11744 Document the branching model for consumers #347

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea817de
IS-11744 Document the branching model for consumers.
Oct 1, 2026
368815c
IS-11744 Address review comments.
Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,23 @@ 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.

> [!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/X.Y
```

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-<version>` (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)

Expand Down