Ideally, all deployment steps should be automated - but some things (especially Keycloak configuration) need to be done manually. They should be documented here!
There are often easier ways to do this in dev if you don't want to follow the manual steps - Reset your Keycloak realm. These are unsuitable for deployed environments (in that case, it deletes all current Keycloak users).
If you're creating a PR with manual steps, please add the steps to the Next section. When doing a deployment, increase the version in package.json, create a section for that version number, and move any pending manual changes to that new section.
Don't delete old sections - just leave them towards the bottom of the file, and add new things at the top.
- Admin must be deployed before the portal to include the Role changes needed for setting client types (sas-UID2-1782-approved-types-to-admin)
- Admin must be deployed before the portal to include the Get Site By Id endpoint utilized (jss-UID2-2065-get-site-by-id)
- Keycloak needs to update realm display name to UID2 Portal
- Email templates need to be released to SendGrid. There are no new ones so mappings shouldn't need to be updated.
- Keycloak needs to be updated to get the new Keycloak email theme.
- In realm settings, switch user profile enable to off ( UID2-1485 update keycloak templates )
- Create api-participant-member role in self_serve_portal_apis client
- Assign api-participant-member to existing users(UID2-1516 setup role check on endpoint) See extra details
- Assign manage-clients to self_serve_portal_apis (UID2-1536 Assign api-partcipant-member when invited user accept T&C) (service account roles tab is in client as well)
- then follow the step 4 and 5 from the same doc.