New commands for user invitation #27
Conversation
|
Hello @jaybrueder ! Thank you for the PR. I will try to review this later this week. But to provide some general feedback regarding the commands: For user invitation, at Netflix, we have a custom HubCommander plugin for this capability, as we want to link a user's (employee in our case) GitHub ID with our internal employee tracking system. This allows us to audit who is actually using our GitHub organizations, and also handle removals from the org when they leave the company. This is something that you should keep in mind, as inviting users to an org through this method could cause user management headaches in the future. |
github/plugin.py
Outdated
|
|
||
| data = {"role": role} | ||
|
|
||
| # Add the outside collab to the repo: |
github/plugin.py
Outdated
| 'Accept': GITHUB_VERSION | ||
| } | ||
|
|
||
| # Add the outside collab to the repo: |
github/plugin.py
Outdated
| response = requests.get('{}{}'.format(GITHUB_URL, api_part), headers=headers, timeout=10) | ||
|
|
||
| if response.status_code != 200: | ||
| raise ValueError("GitHub Problem: Could not list teams: {}".format(response.status_code)) |
There was a problem hiding this comment.
Change to: "GitHub Problem: Could not list teams -- received error code: {}".format(response.status_code).
github/plugin.py
Outdated
| @@ -82,8 +82,23 @@ def __init__(self): | |||
| "user_data_required": True, | |||
| "help": "Delete a GitHub repository.", | |||
| "enabled": True # It is HIGHLY recommended you have auth enabled for this!! | |||
| }, | |||
| "!InviteUser": { | |||
There was a problem hiding this comment.
We should remove this -- or rather, make it a shortcut to !AddUserToTeam.
I feel that it is good practice to have all members exist within a team. Perhaps this can be modified where you can configure a default_team to add new members to.
There was a problem hiding this comment.
I agree on removing it. After having it running with the two commands for a week now, I can see that this command is never used as the desired behaviour is actually the AddUserToTeam command.
github/plugin.py
Outdated
| "func": self.add_user_to_team_command, | ||
| "user_data_required": True, | ||
| "help": "Adds a GitHub user to a specific team inside the organization.", | ||
| "permitted_permissions": ["maintainer", "member"], |
There was a problem hiding this comment.
Change name to permitted_roles to be consistent with GitHub verbiage. Also, member should be the default option and perhaps the role made to be optional. We would have to test if optional parameters can be provided.
|
@mikegrima I made the requested changes. Please let me know if I can improve anything else :) |
|
LGTM |
Hello,
I implemented Hubcommander for a customer of mine. We soon realised that some important commands are missing for us.
I have added these commands to the code and thought you guys probably like them too.
!InviteUserA command that adds a GitHub user to your org. You can also set the permission level (admin or member)
!AddUserToTeamA command that adds an existing user in your org to a specific team. If the user is not yet a part of your org, he will also get an invite. I had to update the existing
invite_user_to_gh_org_teammethod to be able to also set a role here.I am happy to get your feedback and commit any changes this might still need.
There will probably be coming some more updates by me in the futute. The customer really digs Hubcommander :)