Skip to content
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.

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

[IDP-1221] Add documentation, improve logging, do some cleanup #377

Merged
merged 8 commits into from
Oct 8, 2024

Conversation

forevermatt
Copy link
Contributor

IDP-1221 Send error notification email for external-groups sync errors


Added

  • Document (in README) how to set up external-groups syncs from a Google Sheet
  • Log actual changes to Users' groups_external values during a sync
  • Document (in local.env.dist) how to format Google JSON key for env. var.

Fixed

  • Fix parameter data type in PHP DocBlock on Emailer->email()
  • Fix incorrect Exception class usage in EmailLog::logMessage()

Feature PR Checklist

  • Documentation (README, local.env.dist, api.raml, etc.)
  • Run make composershow
  • Run make psr2

@forevermatt forevermatt requested a review from a team as a code owner October 7, 2024 19:16
@forevermatt forevermatt requested review from briskt, mtompset, jason-jackson and hobbitronics and removed request for a team October 7, 2024 19:16
README.md Outdated Show resolved Hide resolved
- `EXTERNAL_GROUPS_SYNC_set1ErrorsEmailRecipient`
- Set this to a single email address.
10. If you need to sync those custom groups to another IDP...
- Ensure that IDP is also running a recent enough version of ID Broker.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Ensure that IDP is also running a recent enough version of ID Broker.
- Ensure that IDP is also running ID Broker version 6.8.0 or later.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since I mentioned a specific version further up, I didn't want to duplicate that here (e.g. in case we later update the minimum version needed in one place and forget to update it in the other).

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: briskt <3172830+briskt@users.noreply.github.com>
Copy link

sonarcloud bot commented Oct 8, 2024

@forevermatt forevermatt merged commit 176b911 into develop Oct 8, 2024
3 checks passed
@forevermatt forevermatt deleted the feature/idp-1221-cleanup-and-documentation branch October 8, 2024 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants