diff --git a/.gitignore b/.gitignore index db75fcc..91334ae 100644 --- a/.gitignore +++ b/.gitignore @@ -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 @@ -173,3 +168,5 @@ buildNumber.properties # End of https://www.toptal.com/developers/gitignore/api/maven,intellij+all,eclipse /patch-tool/.work/ + +.logs diff --git a/README.md b/README.md index e5b9110..3d14dbc 100644 --- a/README.md +++ b/README.md @@ -28,14 +28,14 @@ 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 -d @@ -43,7 +43,7 @@ Note that the packages in de saml plugin are the packages from the Keycloak code *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 @@ -58,6 +58,15 @@ git rebase keycloak git checkout -b release/.x ``` +8. Remove your local `keycloak` branch. + +### Pull Request Reviews + +9. Run the new code from the PR through Test classes, not only `` but also ``. + +10. Also manually test ``&``. + + * Once that works, also test with mappers and encryption. ## Building