Document Google OpenID Connect email attribute

[ptman]

In the example config

Pull Request Checklist

• Pull request is based on the develop branch
• Pull request includes a changelog file. The entry should:
  • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
  • Use markdown where necessary, mostly for code blocks.
  • End with either a period (.) or an exclamation mark (!).
  • Start with a capital letter.
  • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
• Pull request includes a sign off
• Code style is correct
  (run the linters)

[ptman]

This is a very short documentation change that I made using the GitHub web editor. Please let me know if all the boxes still need to be ticked

[DMRobertson]

This is a very short documentation change that I made using the GitHub web editor. Please let me know if all the boxes still need to be ticked

Many thanks for this. Per that comment with the tickboxes, could you please:

• add a changelog entry
• a comment with your sign-off

There's no need to run the linters for a documentation-only change like this.

[DMRobertson]

I'm guessing this corresponds to the three scopes listed here?

https://developers.google.com/identity/protocols/oauth2/scopes#oauth2

[DMRobertson]

Sanity check: have you used this config yourself and confirmed that it works? (On matrix.org we are using the scope name https://www.googleapis.com/auth/userinfo.email.)

[ptman]

It does, and yes.

[ptman]

* add a changelog entry
* a comment with your sign-off

How do you perform these steps using the GitHub web interface?

There's no need to run the linters for a documentation-only change like this.

Thanks, that's what I thought.

[DMRobertson]

How do you perform these steps using the GitHub web interface?

For adding a changelog entry, I think you want to go to the fork and branch that github has created for you and follow the instructions here.

For adding a sign-off, writing a comment on this PR with Signed-off-by: as per the notes here is all that's needed.

[clokep]

* add a changelog entry
* a comment with your sign-off

How do you perform these steps using the GitHub web interface?

You can go to https://github.com/ptman/synapse/tree/patch-1/changelog.d and click the + in the top right and choose "Create new file".

For sign-off you can just add it manually via a comment on the PR.

[ptman]

Signed-off-by: Paul Tötterman paul.totterman@iki.fi

[DMRobertson]

Many thanks, SGTM!