Skip to content

Feature/26.2.x readme with upgrade tests #12

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
0314R merged 4 commits into from
Apr 30, 2026
Merged

Feature/26.2.x readme with upgrade tests #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
992962d
.gitignore .idea folder entirely
0314R Mar 3, 2026
4148d1e
.gitignore .logs folder
0314R Mar 24, 2026
44365ae
Clearer wording for the upgrade process that was already in the Readme
0314R Apr 16, 2026
8067aea
KEYC-1143: (Readme) Expanded the Upgrade process with more explicit T…
0314R Apr 16, 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
9 changes: 3 additions & 6 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,7 @@ local.properties
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn. Uncomment if using
# auto-import.
.idea/artifacts
.idea/compiler.xml
.idea/jarRepositories.xml
.idea/modules.xml
.idea/*.iml
.idea/modules
.idea
*.iml
*.ipr

Expand Down Expand Up @@ -173,3 +168,5 @@ buildNumber.properties

# End of https://www.toptal.com/developers/gitignore/api/maven,intellij+all,eclipse
/patch-tool/.work/

.logs
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@ with a custom frontend.

The steps are as follows:

1. Before you start make sure the latest release available in the plugin repo is up to date with master.
1. Pull the latest release available in the plugin repo, which should be the default branch.

2. Checkout the SAML-extended plugin and go to the `keycloak` branch
2. Make a branch called `keycloak`, only locally. Also, check it out.

3. Checkout the Keycloak source code and go to the correct release branch

4. For every class in the keycloak branch of the SAML-plugin, look up this class in the keycloak source code and paste it in the plugin.
Note that the packages in de saml plugin are the packages from the Keycloak codebase. For those that can run bash scripts there is an script that can do this for you. Simply run it with:
4. For every class in the keycloak branch of the SAML-plugin, look up this class in the keycloak source code and paste it in the plugin,
either manually or by running the script as below:

```
./copy-source.sh -k <keycloak-dir> -d <plugin-dir>
```

*Note: both dirs should not end in a /*

5. Next, rebase the `keycloak` branch onto `main` and address conflicts if they arise.
5. Next, rebase the `keycloak` branch onto the default branch (=latest release branch) and address conflicts if they arise.

```
git checkout master
Expand All @@ -58,6 +58,15 @@ git rebase keycloak
git checkout -b release/<version>.x
```

8. Remove your local `keycloak` branch.

### Pull Request Reviews

9. Run the new code from the PR through Test classes, not only `<Response>` but also `<ArtifactResponse>`.

10. Also manually test `<Response>`&`<ArtifactResponse>`.

* Once that works, also test with mappers and encryption.

## Building

Expand Down
Loading