[code-infra] Automate team sync on about page

Author: brijeshb42

.github/workflows/sync-team-members.yml

@@ -0,0 +1,70 @@
+name: Sync team members
+
+on:
+  workflow_dispatch:
+    inputs:
+      reviewers:
+        description: 'Comma-separated GitHub usernames to request review from'
+        required: false
+        default: 'oliviertassinari'
+  schedule:
+    # Every Monday at 06:00 UTC
+    - cron: '0 6 * * 1'
+
+permissions: {}
+
+jobs:
+  sync:
+    if: github.repository == 'mui/material-ui'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - name: Set up pnpm
+        uses: pnpm/action-setup@0ebf47130e4866e96fce0953f49152a61190b271 # v6.0.9
+      - name: Use Node.js
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
+        with:
+          node-version: '22.18.0'
+          cache: 'pnpm' # https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#caching-packages-dependencies
+      - run: pnpm install
+      - name: Sync team members
+        run: pnpm docs:sync-team
+        env:
+          # syncTeamMembers.ts writes the missing-images summary for the PR body here.
+          SYNC_SUMMARY_FILE: ${{ runner.temp }}/sync-summary.md
+      - name: Create or update pull request
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SYNC_SUMMARY_FILE: ${{ runner.temp }}/sync-summary.md
+          # Empty on scheduled runs, so fall back to the default reviewers.
+          REVIEWERS: ${{ inputs.reviewers || 'oliviertassinari' }}
+        run: |
+          set -euo pipefail
+          if [ -z "$(git status --porcelain)" ]; then
+            echo 'No team member changes. Skipping PR.'
+            exit 0
+          fi
+
+          BRANCH=website/sync-team-members
+          git config user.name 'github-actions[bot]'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+          git switch -C "$BRANCH"
+          git commit --all --message '[website] Sync about page team members'
+          git push --force origin "$BRANCH"
+
+          BODY="$(printf 'Automated sync of the About page team members from the [mui-about API](https://frontend-public.mui.com/api/mui-about).\n\n'; cat "$SYNC_SUMMARY_FILE")"
+
+          if [ -n "$(gh pr list --head "$BRANCH" --state open --json number --jq '.[].number')" ]; then
+            gh pr edit "$BRANCH" --body "$BODY"
+          else
+            gh pr create \
+              --base master \
+              --head "$BRANCH" \
+              --title '[website] Sync about page team members' \
+              --body "$BODY" \
+              --label website \
+              --reviewer "$REVIEWERS"
+          fi

docs/scripts/syncTeamMembers.ts

@@ -3,17 +3,92 @@ import url from 'url';
 import * as fs from 'fs/promises';
 import path from 'path';
 
+interface Person {
+  name: string;
+}
+
+const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
+const teamMembersPath = path.resolve(currentDirectory, '../data/about/teamMembers.json');
+const imagesDirectory = path.resolve(currentDirectory, '../public/static/branding/about');
+
+// Mirror the image filename derivation used in docs/src/components/about/Team.tsx.
+function imageFileName(name: string) {
+  return `${name
+    .split(' ')
+    .map((part) => part.toLowerCase())
+    .join('-')}.png`;
+}
+
+async function fileExists(filePath: string) {
+  try {
+    await fs.access(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function readCurrentMembers(): Promise<Person[]> {
+  try {
+    return JSON.parse(await fs.readFile(teamMembersPath, 'utf8'));
+  } catch {
+    return [];
+  }
+}
+
+// Delete images of removed members and report new members missing a photo.
+async function syncImagesAndSummary(previousMembers: Person[], people: Person[], ciMode: boolean) {
+  const previousNames = new Set(previousMembers.map((person) => person.name));
+  const nextNames = new Set(people.map((person) => person.name));
+  const added = people.filter((person) => !previousNames.has(person.name));
+  const removed = previousMembers.filter((person) => !nextNames.has(person.name));
+
+  // Delete images of members who are no longer part of the team.
+  await Promise.all(
+    removed.map(async (person) => {
+      const imagePath = path.join(imagesDirectory, imageFileName(person.name));
+      if (await fileExists(imagePath)) {
+        await fs.unlink(imagePath);
+      }
+    }),
+  );
+
+  // Flag new members whose image still needs to be added manually.
+  const missingImages = (
+    await Promise.all(
+      added.map(async (person) => {
+        const fileName = imageFileName(person.name);
+        const exists = await fileExists(path.join(imagesDirectory, fileName));
+        return exists ? null : `${person.name} (\`${fileName}\`)`;
+      }),
+    )
+  ).filter((item): item is string => item !== null);
+
+  const summary = missingImages.length
+    ? `### ⚠️ Missing images\n\nAdd a photo for the following new members to \`docs/public/static/branding/about/\`:\n\n${missingImages
+        .map((entry) => `- ${entry}`)
+        .join('\n')}`
+    : '';
+
+  if (summary) {
+    if (ciMode) {
+      await fs.writeFile(process.env.SYNC_SUMMARY_FILE as string, summary, 'utf8');
+    } else {
+      console.log(summary);
+    }
+  }
+}
+
 async function run() {
+  // Read the current roster before overwriting, only when a diff is needed.
+  const previousMembers = process.env.SYNC_SUMMARY_FILE ? await readCurrentMembers() : [];
+
   const response = await fetch('https://frontend-public.mui.com/api/mui-about');
-  const { people } = await response.json();
+  const { people }: { people: Person[] } = await response.json();
 
-  const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
+  await fs.writeFile(teamMembersPath, JSON.stringify(people), 'utf8');
 
-  await fs.writeFile(
-    path.resolve(currentDirectory, '../data/about/teamMembers.json'),
-    JSON.stringify(people),
-    'utf8',
-  );
+  await syncImagesAndSummary(previousMembers, people, !!process.env.SYNC_SUMMARY_FILE);
 
   console.log('done');
 }