docs: Centralize Author/Team Mapping for Commit Tracking #25986

benjisclowder · 2024-07-19T17:07:51Z

This PR removes mapping from public repository and utilizing the team mapping centralized in a private repository, further maintaining author/team mapping in a single, unified location.

Related issues

Fixes: https://github.com/MetaMask/extension-delivery/issues/271

github-actions · 2024-07-19T17:08:03Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

codecov · 2024-07-19T21:06:07Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.67%. Comparing base (003ee98) to head (f080167).
Report is 20 commits behind head on develop.

Additional details and impacted files

@@            Coverage Diff            @@
##           develop   #25986    +/-   ##
=========================================
  Coverage    69.67%   69.67%            
=========================================
  Files         1400     1401     +1     
  Lines        49510    49628   +118     
  Branches     13689    13713    +24     
=========================================
+ Hits         34494    34577    +83     
- Misses       15016    15051    +35

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

metamaskbot · 2024-07-19T21:17:49Z

Builds ready [782fad7]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5
- common: 0, 1, 10, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (69 ± 8 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	69	137	100	16	8
		domContentLoaded	10	59	25	12	6
		load	47	102	69	17	8
		domInteractive	10	59	25	12	6

Bundle size diffs

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

sonarqubecloud · 2024-07-22T11:36:27Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

metamaskbot · 2024-07-22T14:52:36Z

Builds ready [f080167]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5
- common: 0, 1, 10, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (144 ± 158 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	71	183	105	27	13
		domContentLoaded	9	77	28	15	7
		load	39	1578	144	330	158
		domInteractive	9	77	28	15	7

Bundle size diffs

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

chloeYue · 2024-07-23T13:03:04Z

development/generate-rc-commits.js

    console.log('Generation of the CSV file "commits.csv" is in progress...');

    for (const commit of log.all) {
-      const { author, message, hash } = commit;
-      if (commitsByTeam.length >= MAX_COMMITS) {
+      if (processedCommits >= MAX_COMMITS) {


Tested and found the current commitsByTeam.length >= MAX_COMMITSdoes not work because commitsByTeam is a object, not a Map, so it doesn't have a size property. We should track the number of processed commits by processedCommits.

chloeYue · 2024-07-23T13:06:57Z

development/generate-rc-commits.js

-      return team;
-    }
+// Function to get the GitHub username for a given commit hash
+async function getGitHubUsername(commitHash) {


In the teams.json file, the PR author's username (handle) is used, so we need to retrieve the username instead of the author's name from the commit log.

hjetpoluru · 2024-07-23T19:59:51Z

Thanks @chloeYue for taking it up. I believe we can simplify the process here. When fetching the commits, we already obtain the author's information, as shown in the example below. Therefore, we don't need the fetchAuthorTeamsFile and getGitHubUsername functions. This will significantly reduce the number of Git calls. Additionally, we need the team label, which can be achieved by modifying the getPRLabels function to trim the 'team-' prefix and include it in the cvs file. Let me know if you need any help or clarification.

 {
      message: 'fix: token detection and import (#23798) (#23871)',
      author: 'Brian Bergeron',
      prLink: 'https://github.com/MetaMask/metamask-extension/pull/23798',
      releaseLabel: 'release-11.15.0',
      hash: '6ac918d005'
    }

chloeYue · 2024-07-24T08:08:06Z

Thanks @chloeYue for taking it up. I believe we can simplify the process here. When fetching the commits, we already obtain the author's information, as shown in the example below. Therefore, we don't need the fetchAuthorTeamsFile and getGitHubUsername functions. This will significantly reduce the number of Git calls. Additionally, we need the team label, which can be achieved by modifying the getPRLabels function to trim the 'team-' prefix and include it in the cvs file. Let me know if you need any help or clarification.
 {
      message: 'fix: token detection and import (#23798) (#23871)',
      author: 'Brian Bergeron',
      prLink: 'https://github.com/MetaMask/metamask-extension/pull/23798',
      releaseLabel: 'release-11.15.0',
      hash: '6ac918d005'
    }

Hi @hjetpoluru, thanks for your review. We do need the fetchAuthorTeamsFile function because it's necessary to retrieve the teams.json file for author/team mapping. Also, as you can see in your comment, the author's name is displayed, but in the teams.json mapping file, we use GitHub username (handle), which often differ from the author's name. That's why we need to fetch the handle to ensure accurate mapping. Please refer to my comment in this PR for further clarification. For the team label, we've opted for an author/team mapping approach, allowing each feature team to validate PRs from their own members. we don't rely solely on PR labels because this would mean feature teams would need to validate PRs that affect their code but might not originate from their team. Additionally, a PR can be associated with multiple team labels, complicating the validation process. The current approache need more git call but as this script is only executed once per release so i guess it's ok.

benjisclowder and others added 3 commits July 19, 2024 17:09

.

c8bd440

debug authur mapping parsing

4be4690

add.

7737396

benjisclowder added the area-documentation Issues relating to documentation, in the codebase and off. label Jul 19, 2024

benjisclowder requested review from kumavis and a team as code owners July 19, 2024 17:07

metamaskbot added INVALID-PR-TEMPLATE PR's body doesn't match template team-extension-platform labels Jul 19, 2024

benjisclowder added 3 commits July 19, 2024 21:33

lint fix

87d4bf7

.

abf0810

.

782fad7

chloeYue mentioned this pull request Jul 22, 2024

docs: Fix commits script for team mapping #25747

Closed

chloeYue added 2 commits July 22, 2024 18:36

improve

3e7b674

improve format

f080167

chloeYue reviewed Jul 23, 2024

View reviewed changes

hjetpoluru self-requested a review July 23, 2024 20:21

vthomas13 approved these changes Jul 24, 2024

View reviewed changes

pedronfigueiredo approved these changes Jul 24, 2024

View reviewed changes

chloeYue merged commit ed7f9e6 into develop Jul 24, 2024
79 checks passed

chloeYue deleted the fix-generate-rc-commits branch July 24, 2024 14:56

github-actions bot locked and limited conversation to collaborators Jul 24, 2024

metamaskbot added the release-12.3.0 Issue or pull request that will be included in release 12.3.0 label Jul 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Centralize Author/Team Mapping for Commit Tracking #25986

docs: Centralize Author/Team Mapping for Commit Tracking #25986

benjisclowder commented Jul 19, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Jul 19, 2024

codecov bot commented Jul 19, 2024 •

edited

Loading

metamaskbot commented Jul 19, 2024

sonarqubecloud bot commented Jul 22, 2024

metamaskbot commented Jul 22, 2024

chloeYue Jul 23, 2024 •

edited

Loading

chloeYue Jul 23, 2024

hjetpoluru commented Jul 23, 2024

chloeYue commented Jul 24, 2024 •

edited

Loading

docs: Centralize Author/Team Mapping for Commit Tracking #25986

docs: Centralize Author/Team Mapping for Commit Tracking #25986

Conversation

benjisclowder commented Jul 19, 2024 • edited by github-actions bot Loading

Related issues

github-actions bot commented Jul 19, 2024

codecov bot commented Jul 19, 2024 • edited Loading

Codecov Report

metamaskbot commented Jul 19, 2024

sonarqubecloud bot commented Jul 22, 2024

Quality Gate passed

metamaskbot commented Jul 22, 2024

chloeYue Jul 23, 2024 • edited Loading

Choose a reason for hiding this comment

chloeYue Jul 23, 2024

Choose a reason for hiding this comment

hjetpoluru commented Jul 23, 2024

chloeYue commented Jul 24, 2024 • edited Loading

benjisclowder commented Jul 19, 2024 •

edited by github-actions bot

Loading

codecov bot commented Jul 19, 2024 •

edited

Loading

chloeYue Jul 23, 2024 •

edited

Loading

chloeYue commented Jul 24, 2024 •

edited

Loading