Add documentation for the new GitHub useLoginAsId option

2019-01-31 18:26:10 +00:00 · 2019-01-31 18:26:10 +00:00 · 1911b52c6b
parent 03ffd0798c
commit 1911b52c6b
1 changed files with 3 additions and 0 deletions
--- a/Documentation/connectors/github.md
+++ b/Documentation/connectors/github.md
@ -67,6 +67,9 @@ connectors:
    #   - ['acme:site-reliability-engineers'] for 'slug'
    #   - ['acme:Site Reliability Engineers', 'acme:site-reliability-engineers'] for 'both'
    teamNameField: slug
+    # flag which will switch from using the internal GitHub id to the users handle (@mention) as the user id.
+    # It is possible for a user to change their own user name but it is very rare for them to do so
+    useLoginAsId: false
 ```

 ## GitHub Enterprise