Add documentation for the new GitHub useLoginAsId option

1911b52c · James Nord · 03ffd079 · 1911b52c
Commit 1911b52c authored Jan 31, 2019 by James Nord
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 0 deletions

github.md Documentation/connectors/github.md +3 -0

No files found.
--- 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