itsyoboieltr
commented
3 months ago Writing up the results of my investigation:
Team labeling should only happen once, when a pull request is opened. When this happens, the GitHub handle of the author of the pull request can be extracted using the github.event.pull_request.user.login property. Using the GitHub handle, dynamically fetching the GitHub teams a person belongs to in the MetaMask organization is possible using the GitHub GraphQL API.
query($organization: String!, $user: String!) {
organization(login: $organization) {
teams(first: 100, userLogins: [$user]) {
edges {
node {
name
description
slug
}
}
}
}
}This returns data in JSON like:
{
"data": {
"organization": {
"teams": {
"edges": [
{
"node": {
"name": "Extension Platform",
"description": "...",
"slug": "extension-platform"
}
}
]
}
}
}
}A list of teams with some properties extracted. There are many more properties available, but based on https://docs.github.com/en/graphql/reference/objects#team, I thought these would be the relevant ones.
Now that we have a list of teams for the user that submitted the pull request, we need to select a team and pair it to the team's label. This proved to be unexpectedly complex:
- How do we match a team to a label? Making a key-value store for it would undermine the automation part of this issue, as that would require manual maintenance again. There are several options to explore:
- Renaming the teams to match the labels.
- For example, the name of the GitHub team for the Extension Platform team is "Extension Platform" (slug: "extension-platform"). The GitHub label for Extension Platform is "team-extension-platform". If we renamed the GitHub team to "Team Extension Platform", the slug would become "team-extension-platform", making it possible to easily link the two.
- PROS: This is probably the least hacky solution. We can just take the slug property and match it to the label, easy.
- CONS: This would require a strict naming convention for all teams that would like to participate in automatic labeling. All the teams would probably need to update their names. I am not sure if this would break anything?
- Renaming the labels to match the teams
- Very similar to the previous example, but the other way around. I am not sure if this would be easier/harder?
- Keep the team names and labels, but put the team label name in the GitHub team description.
- For the Extension Platform team, we could put the string "Team label: team-extension-platform" in the description of the team. The script would parse the json and extract the team-* substring using regex.
- PROS: By simply editing the description of the GitHub teams the chance of breaking anything is basically zero, so this feels very safe to do.
- CONS: This feels like the hackiest solution, as descriptions should not contain functional features. It also requires the convention of writing "Team label: team-*" in the GitHub team description.
- If we succeed to match the teams to labels, what would happen if a person is in multiple teams? How do we know which label to apply?
- The first idea that came to my mind was just to take the first valid team starting with the slug "team-", and apply that as a label. Teams that do not require labeling should not start with "team-", this way they can opt out. Ideally one user should only have one team starting with the slug "team-". The rest of the teams would be ignored.
- Putting stuff in the description, like: "Labelable".
I am posting this to start a discussion. Looking forward to hearing your ideas! Maybe I missed something, or there is a better way.
gauthierpetetin
What is this about?
PR #25208 added the
add-team-labelGitHub workflow that automatically adds the author's team to the labels when a new PR is opened. The label corresponding to the author is extracted from teams.json found in the MetaMask-planning repository.This issue was opened to capture the desired outcome of the automatic team labeling, as @seaona raised a question about the maintenance of the aforementioned teams.json file in https://github.com/MetaMask/metamask-extension/pull/25208#pullrequestreview-2115428545:
Ideally, instead of having a teams.json file which requires manual maintenance, it would be great to dynamically fetch the available GitHub teams and match the author to one of the teams to find the correct label. This way we would have a fully automated process for GitHub team labeling.
Scenario
No response
Design
No response
Technical Details
No response
Threat Modeling Framework
No response
Acceptance Criteria
No response
Stakeholder review needed before the work gets merged
References
No response