tools: add workflow to ensure README lists are in sync with gh teams

PR-URL: #53901
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>

Author: aduh95

.github/workflows/linters.yml

@@ -185,4 +185,21 @@ jobs:
  - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
 with:
 persist-credentials: false
- - run: tools/lint-readme-lists.mjs
+ - name: Get team members if possible
+id: team_members
+run: |
+ get_list_members() {
+ TEAM="$1"
+ QUOTE='"'
+ gh api "/orgs/nodejs/teams/$TEAM/members" -X GET -f per_page=100 --jq "map(.login) | ${QUOTE}${TEAM}=\(tojson)${QUOTE}"
+ }
+ [ -z "$GITHUB_TOKEN" ] || (
+ get_list_members "collaborators"
+ get_list_members "issue-triage"
+ get_list_members "tsc"
+ ) >> "$GITHUB_OUTPUT"
+env:
+GITHUB_TOKEN: ${{ secrets.GH_USER_TOKEN }}
+ - run: tools/lint-readme-lists.mjs "$TEAMS"
+env:
+TEAMS: ${{ tojson(steps.team_members.outputs) }}

tools/lint-readme-lists.mjs

@@ -1,17 +1,26 @@
 #!/usr/bin/env node
 
-// Validates the list in the README are in the correct order.
+// Validates the list in the README are in the correct order, and consistent with the actual GitHub teams.
 
+importassertfrom'node:assert';
 import{open}from'node:fs/promises';
+import{argv}from'node:process';
 
-constlists=[
-'TSC voting members',
-'TSC regular members',
-'TSC emeriti members',
-'Collaborators',
-'Collaborator emeriti',
-'Triagers',
-];
+constlists={
+'__proto__': null,
+
+'TSC voting members': 'tsc',
+'TSC regular members': null,
+'TSC emeriti members': null,
+'Collaborators': 'collaborators',
+'Collaborator emeriti': null,
+'Triagers': 'issue-triage',
+};
+constactualMembers={
+__proto__: null,
+// The bot is part of `@nodejs/collaborators`, but is not listed in the README.
+collaborators: newSet().add('nodejs-github-bot'),
+};
 consttscMembers=newSet();
 
 constreadme=awaitopen(newURL('../README.md',import.meta.url),'r');
@@ -23,26 +32,47 @@ let lineNumber = 0;
 forawait(constlineofreadme.readLines()){
 lineNumber++;
 if(line.startsWith('### ')){
-currentList=lists[lists.indexOf(line.slice(4))];
+currentList=line.slice(4);
 previousGithubHandle=null;
 }elseif(line.startsWith('#### ')){
-currentList=lists[lists.indexOf(line.slice(5))];
+currentList=line.slice(5);
 previousGithubHandle=null;
-}elseif(currentList&&line.startsWith('* [')){
-constcurrentGithubHandle=line.slice(3,line.indexOf(']')).toLowerCase();
-if(previousGithubHandle&&previousGithubHandle>=currentGithubHandle){
-thrownewError(`${currentGithubHandle} should be listed before ${previousGithubHandle} in the ${currentList} list (README.md:${lineNumber})`);
+}elseif(currentListinlists&&line.startsWith('* [')){
+constcurrentGithubHandle=line.slice(3,line.indexOf(']'));
+constcurrentGithubHandleLowerCase=currentGithubHandle.toLowerCase();
+if(
+previousGithubHandle&&
+previousGithubHandle>=currentGithubHandleLowerCase
+){
+thrownewError(
+`${currentGithubHandle} should be listed before ${previousGithubHandle} in the ${currentList} list (README.md:${lineNumber})`,
+);
 }
 
-if(currentList==='TSC voting members'||currentList==='TSC regular members'){
+if(
+currentList==='TSC voting members'||
+currentList==='TSC regular members'
+){
 tscMembers.add(currentGithubHandle);
 }elseif(currentList==='Collaborators'){
 tscMembers.delete(currentGithubHandle);
 }
-previousGithubHandle=currentGithubHandle;
+if(lists[currentList]){
+(actualMembers[lists[currentList]]??=newSet()).add(currentGithubHandle);
+}
+previousGithubHandle=currentGithubHandleLowerCase;
 }
 }
+console.info('Lists are in the alphabetical order.');
+
+assert.deepStrictEqual(tscMembers,newSet(),'Some TSC members are not listed as Collaborators');
 
-if(tscMembers.size!==0){
-thrownewError(`Some TSC members are not listed as Collaborators: ${Array.from(tscMembers)}`);
+if(argv[2]&&argv[2]!=='{}'){
+constreviver=(_,value)=>
+(typeofvalue==='string'&&value[0]==='['&&value.at(-1)===']' ?
+newSet(JSON.parse(value)) :
+value);
+assert.deepStrictEqual(JSON.parse(argv[2],reviver),{ ...actualMembers});
+}else{
+console.warn('Skipping the check of GitHub teams membership.');
 }